Forbind Pipedream med GenderAPI.io V2

Forbered kontoen og kildeposten

Dette eksempel beriger poster i Twilio SendGrid ud fra e-mailadressen. 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 Pipedream

• Vælg en Twilio SendGrid-hændelse eller en tidsplan, der passer til din konto og dit workflow. Kontrollér en testkontakt, gem dens stabile id, og spring tomme e-mailadresser over før berigelsestrinnet. Det tilgængelige interval for triggeren er en platformindstilling og ikke et tilsagn fra GenderAPI.
• Tilføj handlingen Send any HTTP Request, vælg POST, og indtast URL'en nedenfor. Konfigurér en JSON-brødtekst med type = email, value = kontaktens e-mailadresse og options.ai_mode = off.
• Gem nøglen med Pipedreams kontrolelementer til legitimationsoplysninger eller miljøvariabler. Sæt Authorization til Bearer efterfulgt af hemmeligheden og Content-Type til application/json. Fortsæt ikke med den native godkendelse med nøglen i forespørgselsstrengen, og vis ikke nøglen i noget trin.
• Opret brødteksten som et JSON-objekt med de tilknytningskontroller, handlingen understøtter. Sammensæt ikke rå JSON ved at sætte kontaktens værdier sammen uden at escape specialtegn. Kontrollér forhåndsvisningen af forespørgslen, før du kører en afgrænset test.

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

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

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

Gennemgå det svar, HTTP-trinnet eksporterer, og find den fortolkede brødtekst. Hvis den valgte handling returnerer brødteksten som tekst, skal du fortolke den én gang, før du læser data og meta. Feltet data i transportens indpakning er ikke det samme som feltet data i V2-brødteksten.

Til et kodebaseret workflow med eksplicit styring af timeout, omdirigeringer og nye forsøg kan du bruge den testede Node.js-guide nedenfor. Den generiske handling og den native app kan have forskellige standardindstillinger for transporten.

• Pipedreams offentlige GenderAPI.io-komponent →
• Handlinger til HTTP-forespørgsler i Pipedream →
• Hemmelige miljøvariabler i Pipedream →
• Indstillinger for workflows og nye forsøg i Pipedream →

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

Gem det kontakt-id, triggeren returnerer, sammen med den fortolkede V2-brødtekst. Opdatér kun de planlagte brugerdefinerede felter i SendGrid efter resultatkontrollerne ovenfor. Bevar det navn, kontakten selv har angivet: Et data.name, der er udledt af e-mailadressen, er en udledt kandidat og ikke en bekræftet erstatning.

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

Pipedream dokumenterer automatiske nye forsøg fra det mislykkede trin, afhængigt af abonnementet. Kontrollér disse indstillinger og adfærden for nye forsøg i den valgte HTTP-handling. Et nyt forsøg i et mislykket berigelsestrin kan medføre nye omkostninger. En senere fejl i målsystemet skal rettes med det gemte output fra berigelsen.

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