Forbind Integrately med GenderAPI.io V2

Forbered kontoen og kildeposten

Dette eksempel beriger poster i Mailchimp ud fra navnet. Du skal have adgang til kildeappen og målappen, en kontonøgle til GenderAPI.io og de platformfunktioner, HTTP-handlingen bruger. Guiden indeholder hverken fungerende legitimationsoplysninger eller tilknyttede konti.

V1 og V2 bruger den samme kontonøgle og den samme saldo. Før du konfigurerer en betalt forespørgsel, skal du kontrollere nøglen med GET /api/v2/usage og sikre dig, at meta.access.mode har værdien api_key i svaret fra dette endpoint. En manglende eller ukendt nøgle kan falde tilbage til den delte IP-prøveadgang. En automatisering i produktion bør ikke afhænge af det, uden at du ved det.

Hold workflowet slået fra, mens du konfigurerer det. En testforudsigelse bruger almindelige kreditter. Vejledningerne er gennemgået ud fra den offentlige dokumentation og V2-kontrakten. Der er ikke kørt et godkendt workflow fra start til slut på nogen platform i forbindelse med denne udgivelse.

• Godkendelse og gratis kontrol af forbruget →

Konfigurér GenderAPI.io V2-forespørgslen i Integrately

• Vælg en Mailchimp-trigger for abonnenter, og kontrollér en testpost. Gem målgruppens (Audience) og abonnentens id til opdateringen, vælg det faktiske navnefelt, og spring poster uden navn over.
• Find Webhook/API og den tilsvarende handling til at sende data til en URL. Kontrollér den tilgængelige opsætning, før du fortsætter: Kontrakten nedenfor kræver godkendte headere og en indlejret JSON-brødtekst, og editorens aktuelle kontrolelementer er ikke kontrolleret uafhængigt her.
• Hvis handlingen opfylder disse krav, vælger du POST og V2-endpointet nedenfor. Sørg med de kontrolelementer, der findes i din konto, for, at den udgående forespørgsel indeholder Authorization: Bearer YOUR_API_KEY og Content-Type: application/json.
• Opret en JSON-brødtekst med type = name, value = det tilknyttede navn og options med ai_mode = off. Kontrollér forhåndsvisningen af forespørgslen for den valgte handling: En flad formularpayload er ikke en V2-brødtekst i JSON, heller ikke selvom headeren Content-Type er angivet.
• Til dynamiske navne bruger du platformens kontrolelementer til tilknytning eller JSON-serialisering. Hvis den valgte handling ikke kan bevare indlejret JSON eller godkendte headere, skal du bruge et trin med HTTP-understøttelse i stedet for at skrive nøglen eller JSON i parametrene i forespørgselsstrengen.

Kontrollér JSON-brødteksten, før du sender den

Eksemplet viser et fast input. Det er ikke et forventet resultat. Kontrollér først forespørgslens struktur, og erstat derefter value med det tilknyttede kildefelt ved hjælp af korrekt JSON-serialisering. Send ikke platformens tilknytningsudtryk til API'et som bogstavelig tekst.

Ved andre input sætter du type til name, email eller username og angiver den tilsvarende værdi i value. Tilføj kun country, hvis du har en pålidelig kontekst. Feltet er valgfrit og bruges ikke til at fastslå, hvilket land en person bor i.

{
  "type": "name",
  "value": "Alice",
  "options": {
    "ai_mode": "off"
  }
}

• Felter, typer og standardværdier i forespørgslen →

Kontrollér HTTP-trinnet, før du aktiverer opdateringer

Afprøv en handling afgrænset, og gennemgå den returnerede brødtekst, før du vælger felter i de efterfølgende trin. Native GenderAPI.io-trin og Webhook/API-trin kan vise forskellige feltetiketter, også for den samme kildekunde.

Opbevar nøglen i de kontrolelementer, der er beregnet til forbindelsen eller til godkendelse af forespørgslen, og begræns, hvem der kan se eller dele automatiseringen. Denne offentlige guide indeholder hverken en fungerende nøgle, en eksporteret forbindelse eller en forudkonfigureret opdatering af kunder.

• Webhook/API-handlinger i Integrately →
• Integratelys dokumentation →

Håndtér identified, unknown og fejl hver for sig

Fortolk svarets brødtekst, før du vælger en opdatering i målsystemet. JSON-stierne nedenfor henviser til brødteksten i V2-svaret. Din platform kan pakke den ind eller gøre den flad. Kontrollér den struktur, der faktisk returneres, med en afgrænset test, og gem resultatet sammen med kildepostens id.

En forudsigelse fastslår hverken en persons identitet eller det køn, personen selv oplyser. Opbevar den adskilt fra de oplysninger, personen selv har givet. Fastlæg kriterier for accept på data, der er repræsentative for dit anvendelsestilfælde, og vurdér konfidens fra datasættet og konfidens fra AI hver for sig.

• Fuld dokumentation af V2-svaret →
• Fejl, timeouts og beslutninger om nye forsøg →

Opdatér kun den tilsvarende post i Mailchimp

Brug de gemte Mailchimp-id'er for målgruppen (Audience) og abonnenten til at vælge målposten. Tilføj betingelser for resultatets status og for kontrollerne af adgang og opkrævning ovenfor, før du skriver data i et felt beregnet til udledte data eller i et godkendt tag. Konvertér aldrig et manglende køn eller værdien null til en standardkategori for kontakten.

Afprøv grenene for et identified-resultat, et unknown-resultat og en fejl, før du aktiverer opdateringer. Med fiktive eksempelsvar kan du kontrollere forgreningens betingelser uden at sende en ny forudsigelse. Opdateringen i målappen skal afhænge af kontrollerne ovenfor og må ikke overskrive felter eller tags, der ikke har noget med den at gøre.

• Svarfelter og ukendte resultater →
• Nøjagtighed og konfidens forklaret →
• Datakilder og databasens daterede profil →

Styr nye forsøg og gentagne opkrævninger

Integrately dokumenterer automatiske nye forsøg, herunder indstillinger, der gælder for hele virksomheden. Kontrollér politikken og aktivitetshistorikken, før du slår denne automatisering til, og vurdér virkningen på andre workflows, før du ændrer en fælles indstilling. Hver gentaget HTTP-forespørgsel er en selvstændig forespørgsel, der opkræves. Gem gennemførte output, så du kan rette en senere fejl i Mailchimp uden en ny forespørgsel.

Hver ny forespørgsel til GenderAPI er en selvstændig operation. Fjern dubletter af gentagne kildehændelser i dit workflow før afsendelse ved hjælp af det gemte kilde-id og behandlingsstatus. Kildepostens id er ikke en nøgle, der beskytter mod gentagelser på serversiden.

Et gennemført unknown-resultat er et fuldstændigt resultat, der opkræves. Ved en timeout eller et ufuldstændigt svar kan både resultatet og opkrævningen være ukendte: Gem forespørgslens reference, hvis den findes, og afklar opkrævningen, før du sender forespørgslen igen. Overhold headeren Retry-After, når den følger med et svar om overskredet forespørgselsgrænse.

• Kreditter og opkrævningsstatus →

Beslut, hvornår AI skal bruges

forceToGenderize er valgfrit for navne, e-mailadresser og brugernavne. Når det er slået til, skal du udelade ai_mode eller bruge fallback. off og always kan ikke kombineres med denne indstilling og returnerer 422. En positiv startsaldo er nok til at starte en forespørgsel, også selvom den endelige opkrævning gør saldoen negativ.

Kaldenavnstilstanden kan returnere et køn sammen med name: null. Den kan også give et ukendt resultat. Hverken den almindelige automatiske AI-fallback eller fortolkningen af kaldenavne garanterer et korrekt svar eller en værdi, der ikke er null.

• AI-indstillinger og fortolkning af kaldenavne →
• Kreditter og forbrug →

Kontrollér workflowet, før du øger mængden

• Kontrollér med en afgrænset test den JSON, der faktisk serialiseres, de fortolkede resultatstier, adgangen med API-nøgle og bekræftelsen af opkrævningen. Afprøv om muligt håndteringen af unknown-resultater og fejl med eksempelsvar.
• Afklar, hvilke trin i workflowet der gentages, og hvilke kundefelter der ændres. Gem kildepostens id, det modtagne svar og forespørgslens reference, så en senere fejl i målsystemet ikke kræver en ny forespørgsel.
• Aktivér først en lille, kontrolleret kørsel, og kontrollér poster og kreditter, før du øger paralleliteten. Kreditter i GenderAPI og de opgaver eller operationer, som automatiseringsplatformen opkræver, er separate omkostninger.
• Til batches bruger du POST /api/v2/gender/batch med op til 50 elementer ved adgang med API-nøgle eller 10 med IP-prøveadgangen. Arrayet items kan blande navne, e-mailadresser og brugernavne med eksplicitte indstillinger og et unikt id for hvert element. Kontrollér hvert resultat: Et HTTP 200-svar kan indeholde fejl for enkelte elementer. Om en native connector understøtter batches, skal kontrolleres separat.

• Batches og fejl for enkelte elementer →
• Implementeringsguide til Python →
• Implementeringsguide til Node.js →

Ofte stillede spørgsmål