Koble Pipedream til GenderAPI.io V2

Klargjør kontoen og kildeposten

Dette eksemplet beriker poster i Twilio SendGrid basert på e-postadressen. 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 Pipedream

• Velg den Twilio SendGrid-hendelsen eller tidsplanen som passer til kontoen og arbeidsflyten din. Kontroller én testkontakt, behold dens stabile ID, og hopp over tomme e-postverdier før berikingssteget. Det tilgjengelige intervallet for utløseren er en innstilling i plattformen, ikke en garanti fra GenderAPI.
• Legg til handlingen Send any HTTP Request, velg POST, og angi URL-en nedenfor. Konfigurer en JSON-body med type = email, value = kontaktens e-post og options.ai_mode = off.
• Lagre nøkkelen med kontrollene for påloggingsopplysninger eller miljøvariabler i Pipedream. Sett Authorization til Bearer etterfulgt av hemmeligheten, og sett Content-Type til application/json. Ikke gjenbruk den innebygde autentiseringen med nøkkel i spørrestrengen, og ikke skriv ut nøkkelen i noe steg.
• Bygg bodyen som et JSON-objekt med tilordningskontrollene handlingen støtter. Unngå å sette sammen rå JSON ved å koble sammen kontaktverdier som ikke er escapet. Kontroller forhåndsvisningen av forespørselen før du bevisst kjører én test.

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": "email",
  "value": "alex@example.com",
  "options": {
    "ai_mode": "off"
  }
}

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

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

Gå gjennom svaret som HTTP-steget eksporterer, og finn den tolkede bodyen. Hvis den valgte handlingen returnerer bodyen som tekst, tolker du den én gang før du leser data og meta. Feltet data i transportens innpakning er ikke det samme som feltet data i V2-bodyen.

For en kodebasert arbeidsflyt med eksplisitt håndtering av tidsavbrudd, omdirigeringer og nye forsøk kan du bruke den testede Node.js-guiden som det lenkes til nedenfor. Den generiske handlingen og den innebygde appen kan ha ulike standardinnstillinger for transport.

• Den offentlige GenderAPI.io-komponenten i Pipedream →
• Handlinger for HTTP-forespørsler i Pipedream →
• Hemmelige miljøvariabler i Pipedream →
• Innstillinger for arbeidsflyter og nye forsøk i Pipedream →

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 Twilio SendGrid

Hold kontaktens ID fra utløseren sammen med den tolkede V2-bodyen. Når resultatkontrollene nedenfor er utført, oppdaterer du bare de planlagte egendefinerte feltene i SendGrid. Bevar et navn som kontakten selv har oppgitt: data.name utledet fra en e-postadresse er en utledet kandidat, ikke en bekreftet erstatning.

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

Pipedream dokumenterer automatiske nye forsøk fra det mislykkede steget, avhengig av abonnementet. Gå gjennom disse innstillingene og eventuell håndtering av nye forsøk i den valgte HTTP-handlingen. Et nytt forsøk i et mislykket berikingssteg kan føre til ny belastning. En senere feil i målsystemet bør rettes ut fra det lagrede utdataet fra berikingen.

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