Koble Integrately til GenderAPI.io V2

Klargjør kontoen og kildeposten

Dette eksemplet beriker poster i Mailchimp basert på navnet. Du trenger tilgang til kildeappen og målappen, en kontonøkkel for GenderAPI.io og plattformfunksjonene som HTTP-handlingen bruker. Veiledningen inneholder verken fungerende påloggingsopplysninger eller tilkoblede kontoer.

V1 og V2 bruker den samme kontonøkkelen og den samme saldoen. Før du setter opp en forespørsel som belastes, bør du kontrollere nøkkelen med GET /api/v2/usage og sjekke at meta.access.mode har verdien api_key i svaret fra dette endepunktet. En manglende eller ukjent nøkkel kan falle tilbake til den delte IP-prøveperioden. En automatisering i produksjon bør ikke drives av dette uten at du vet om det.

La arbeidsflyten være deaktivert mens du konfigurerer den. En testprediksjon bruker vanlige kreditter. Veiledningen er gjennomgått mot offentlig dokumentasjon og V2-kontrakten. Det er ikke kjørt noen autentisert arbeidsflyt fra start til slutt på noen plattform i forbindelse med denne publiseringen.

• Autentisering og gratis kontroll av forbruket →

Konfigurer GenderAPI.io V2-forespørselen i Integrately

• Velg Mailchimp-utløseren for abonnenter, og kontroller én testpost. Behold ID-ene for målgruppen (Audience) og abonnenten til oppdateringen, velg det faktiske feltet for fornavn, og hopp over poster uten navn.
• Finn Webhook/API og handlingen for å sende data til en URL. Kontroller det tilgjengelige oppsettet før du fortsetter: Kontrakten nedenfor krever autentiserte headere og en nestet JSON-body, og de gjeldende kontrollene i redigeringsprogrammet er ikke kontrollert uavhengig her.
• Hvis handlingen oppfyller disse kravene, velger du POST og V2-endepunktet nedenfor. Sørg for at den utgående forespørselen inneholder Authorization: Bearer YOUR_API_KEY og Content-Type: application/json, med kontrollene som er tilgjengelige i kontoen din.
• Bygg en JSON-body med type = name, value = det tilordnede fornavnet og options med ai_mode = off. Kontroller forhåndsvisningen av forespørselen for den valgte handlingen: En flat skjemapayload er ikke V2-bodyen i JSON.
• Bruk plattformens kontroller for JSON-tilordning eller serialisering for dynamiske navn. Hvis den valgte handlingen ikke kan bevare nestet JSON eller autentiserte headere, bruker du et steg med HTTP-støtte i stedet for å legge nøkkelen eller JSON i parametere i spørrestrengen.

Kontroller JSON-bodyen før du sender den

Eksemplet viser en fast inndata, ikke et forventet resultat. Kontroller først strukturen på forespørselen, og erstatt deretter value med det tilordnede kildefeltet ved hjelp av korrekt JSON-serialisering. Ikke lim inn plattformens tilordningsuttrykk i API-et som bokstavelig tekst.

For andre inndata setter du type til name, email eller username og oppgir den tilsvarende verdien i value. Legg bare til country når du har pålitelig kontekst. Feltet er valgfritt og brukes ikke til å slå opp hvilket land en person bor i.

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

• Alle felt, typer og standardverdier i forespørselen →

Kontroller HTTP-steget før du slår på oppdateringer

Test én handling bevisst, og gå gjennom den returnerte bodyen før du velger felt i senere steg. Innebygde GenderAPI.io-steg og Webhook/API-steg kan vise ulike feltetiketter, selv når kildekunden er den samme.

Oppbevar nøkkelen i kontrollene som er beregnet for tilkoblingen eller for autentisering av forespørselen, og begrens hvem som kan se eller dele automatiseringen. Denne offentlige guiden inneholder verken en fungerende nøkkel, en eksportert tilkobling eller en forhåndskonfigurert oppdatering av kunder.

• Webhook/API-handlinger i Integrately →
• Dokumentasjonen til Integrately →

Håndter identified, unknown og feil hver for seg

Tolk svarets body før du velger en oppdatering i målsystemet. JSON-stiene nedenfor viser til bodyen i V2-svaret. Plattformen din kan pakke den inn eller gjøre den flat. Bekreft strukturen som faktisk returneres, med en bevisst test, og hold resultatet knyttet til kildepostens ID.

Et estimat fastslår verken en persons identitet eller kjønn som personen selv har oppgitt. Lagre det atskilt fra opplysninger personen selv har gitt. Velg akseptkriterier ut fra data som er representative for ditt eget bruksområde, og vurder konfidens fra datasettet og konfidens fra KI hver for seg.

• Fullstendig referanse for V2-svaret →
• Beslutninger ved feil, tidsavbrudd og nye forsøk →

Oppdater bare den tilsvarende posten i Mailchimp

Bruk de lagrede ID-ene for målgruppen (Audience) og abonnenten i Mailchimp til å velge målposten. Legg til betingelser for resultatets status og for kontrollene av tilgang og belastning nedenfor før du skriver til et eget felt for utledede data eller en godkjent tagg. Gjør aldri et manglende kjønn eller verdien null om til en standardkategori for kontakten.

Test grenene for et identified-resultat, et ukjent resultat og en feil før du slår på oppdateringer. Med fiktive eksempelsvar kan du kontrollere betingelsene for grenene uten å sende en ny forespørsel om et estimat. Oppdateringen i målappen skal avhenge av kontrollene ovenfor og skal ikke overskrive felter eller tagger som ikke er relevante.

• Svarfelt og ukjente resultater →
• Nøyaktighet og konfidens forklart →
• Datakilder og den daterte profilen til datasettet →

Kontroller nye forsøk og gjentatte belastninger

Integrately dokumenterer automatiske nye forsøk, inkludert innstillinger som gjelder for hele virksomheten. Gå gjennom policyen og oppgavehistorikken før du slår på denne automatiseringen, og vurder virkningen på andre arbeidsflyter før du endrer en felles innstilling. Hver gjentatt HTTP-forespørsel er en selvstendig forespørsel som belastes. Behold vellykkede utdata, slik at en senere feil i Mailchimp kan rettes uten en ny forespørsel.

Hver nye forespørsel til GenderAPI er en selvstendig operasjon. Fjern gjentatte kildehendelser i arbeidsflyten din før sending ved hjelp av en lagret kilde-ID og behandlingsstatus. ID-en til kildeposten er ikke en nøkkel som beskytter mot gjentakelser på serversiden.

Et vellykket ukjent resultat er et fullført resultat som belastes. Ved tidsavbrudd eller et ufullstendig svar kan både resultatet og belastningen være ukjent. Behold referansen til forespørselen når den finnes, og avstem belastningen før du sender forespørselen på nytt. Følg headeren Retry-After når den finnes i svar om hastighetsgrense.

• Kreditter og belastningsstatus →

Bestem når KI skal brukes

forceToGenderize er valgfritt for navn, e-postadresser og brukernavn. Når det er aktivert, utelater du ai_mode eller bruker fallback; off og always kan ikke kombineres med dette alternativet og gir 422. En positiv startsaldo er nok til å starte en forespørsel, selv om den endelige belastningen gjør saldoen negativ.

Kallenavnmodus kan returnere et kjønn sammen med name: null. Den kan også gi et ukjent resultat. Verken vanlig KI-reserve eller tolkning av kallenavn garanterer et riktig svar eller en verdi som ikke er null.

• KI-alternativer og tolkning av kallenavn →
• Kreditter og forbruk →

Kontroller arbeidsflyten før du øker volumet

• Kontroller den faktisk serialiserte JSON-en, de tolkede resultatstiene, tilgangen med API-nøkkel og bekreftet belastning med en bevisst test. Test håndteringen av unknown-resultater og feil med eksempelsvar der det er mulig.
• Avklar hvilke steg i arbeidsflyten som gjør nye forsøk, og hvilke kundefelt som endres. Behold kildepostens ID, det fullførte svaret og forespørselens referanse, slik at en senere feil i målsystemet ikke krever en ny forespørsel.
• Aktiver først en liten, kontrollert kjøring, og kontroller postene og kredittene før du øker parallelliteten. Kreditter i GenderAPI og oppgavene eller operasjonene som automatiseringsplattformen belaster, er separate kostnader.
• For samleforespørsler bruker du POST /api/v2/gender/batch med opptil 50 elementer ved tilgang med API-nøkkel eller 10 i IP-prøveperioden. Arrayet items kan blande navn, e-postadresser og brukernavn, med eksplisitte innstillinger og en unik ID for hvert element. Kontroller hvert resultat: Et HTTP 200-svar kan inneholde feil for enkeltelementer. Om en innebygd kobling støtter samleforespørsler, må kontrolleres separat.

• Samleforespørsler og feil for enkeltelementer →
• Implementeringsguide for Python →
• Implementeringsguide for Node.js →

Ofte stilte spørsmål