Pipedream · API V2 -työnkulku

Yhdistä Pipedream ja GenderAPI.io V2

Yhdistä Pipedream GenderAPI.io V2:een Twilio SendGrid -tietueita varten. Valitse oikea yhteys, lähetä type ja value ja käsittele sitten data, meta, krediitit ja virheet.

Valitse Pipedream-yhteys, joka vastaa API-määrittelyäsi

Tämän oppaan HTTP-määritys kutsuu GenderAPI.io V2:ta osoitteessa https://api.genderapi.io/api/v2/gender. Lähetä type ja value JSON-rungossa. Ennuste luetaan kentästä data ja pyynnön sekä laskutuksen tiedot kentästä meta. Valmiilla liittimillä on omat määrittelynsä, jotka kuvataan alla.

Tarkistamamme julkinen GenderAPI.io-komponentti Pipedream-palvelussa käyttää vanhaa perus-URL-osoitetta https://api.genderapi.io/api ja lähettää arvon name tai email, valinnaisen arvon country ja API-avaimen kyselyparametreina. Julkaistu toteutus on V1-liitin, ei V2:n JSON-endpoint.

Voit pitää olemassa olevan valmiin toiminnon sen omassa määrittelyssä tai lisätä V2:lle yleisen HTTP-vaiheen. Älä oleta, että valmiin yhdistetyn tilin automaattinen todennus sopii tähän erilliseen V2-pyyntöön: ohje käyttää nimenomaisesti Bearer-otsaketta.

Valmistele tili ja lähdetietue

Tämä esimerkki rikastaa Twilio SendGrid -tietueita sähköpostiosoitteen perusteella. Tarvitset pääsyn lähde- ja kohdesovellukseen, GenderAPI.io-tilin API-avaimen sekä ne alustan ominaisuudet, joita HTTP-toiminto käyttää. Opas ei sisällä toimivia tunnistetietoja eikä yhdistettyjä tilejä.

V1 ja V2 käyttävät samaa tilin API-avainta ja samaa saldoa. Tarkista avain pyynnöllä GET /api/v2/usage ennen kuin määrität veloitettavan haun, ja varmista, että kentän meta.access.mode arvo on tämän endpointin vastauksessa api_key. Puuttuva tai tunnistamaton avain voi siirtyä käyttämään yhteistä IP-kokeilua, eikä tuotannon automaation pidä huomaamatta toimia sen varassa.

Pidä työnkulku poissa käytöstä sen määrittämisen ajan. Myös testiennusteen lähettäminen kuluttaa tavallisia krediittejä. Nämä ohjeet on tarkistettu julkista dokumentaatiota ja V2:n määrittelyä vasten; tätä julkaisua varten ei ajettu todennettua työnkulkua alusta loppuun millään alustalla.

Määritä GenderAPI.io V2 -pyyntö Pipedream-palvelussa

  • Valitse Twilio SendGrid -tapahtuma tai ajastus, joka sopii tiliisi ja työnkulkuusi. Tarkista yksi testiyhteystieto, säilytä sen pysyvä tunniste ja ohita tyhjät sähköpostiarvot ennen rikastusvaihetta. Käynnistimen käytettävissä oleva aikaväli on alustan asetus, ei GenderAPI:n takuu.
  • Lisää toiminto Send any HTTP Request, valitse POST ja aseta alla oleva URL-osoite. Määritä JSON-runko, jossa on type = email, value = yhteystiedon sähköpostiosoite ja options.ai_mode = off.
  • Tallenna avain Pipedream-palvelun tunnistetieto- tai ympäristömuuttuja-asetuksilla. Aseta Authorization-otsakkeen arvoksi Bearer ja sen perään tämä salaisuus, ja aseta Content-Type-arvoksi application/json. Älä käytä uudelleen valmiin liittimen kyselyparametriin perustuvaa avaintodennusta äläkä tulosta avainta missään vaiheessa.
  • Rakenna runko JSON-objektiksi toiminnon tukemilla kenttien yhdistämisen säätimillä. Älä kokoa raakaa JSON-tekstiä yhdistämällä koodaamattomia yhteystietoarvoja. Tarkista pyynnön esikatselu ennen kuin ajat harkitusti yhden testin.
HTTP-asetusArvoTarkoitus
MethodPOSTLähettää yhden ennustepyynnön.
URLhttps://api.genderapi.io/api/v2/genderGenderAPI.io V2:n endpoint yksittäisille ennusteille.
AuthorizationBearer YOUR_API_KEYKorvaa paikkamerkki alustan todennus- tai otsakeasetuksissa.
Content-Typeapplication/jsonLähettää objektin, jonka sisällä on options-objekti, ei lomakekenttiä.
options.ai_modeoffTarkoituksellinen ensimmäinen testi pelkällä tietoaineistolla. Tavallinen veloitus on 1 krediitti, vaikka tulos olisi tuntematon.

Tarkista JSON-runko ennen lähettämistä

Tämä on kiinteä esimerkkisyöte, ei ennustettu tulos. Tarkista ensin pyynnön rakenne ja korvaa sitten kentän value arvo yhdistetyllä lähdekentällä, joka on sarjallistettu oikein JSON-muotoon. Älä lähetä alustan kenttien yhdistämislausekkeita API:lle kirjaimellisina merkkijonoina.

Jos syöte on toisenlainen, aseta type arvoon name, email tai username ja anna vastaava value. Lisää country vain, kun luotettava konteksti on saatavilla; kenttä on valinnainen eikä selvitä henkilön asuinmaata.

Pipedream-pyyntö GenderAPI.io V2:een
{
  "type": "email",
  "value": "alex@example.com",
  "options": {
    "ai_mode": "off"
  }
}

Tarkista HTTP-vaihe ennen päivitysten käyttöönottoa

Tarkista HTTP-vaiheen viemä vastaus ja etsi jäsennetty runko. Jos valitsemasi toiminto palauttaa rungon tekstinä, jäsennä se kerran ennen kuin luet kentät data ja meta. Siirtokääreen oma data-kenttä on eri asia kuin V2-rungon data-kenttä.

Jos työnkulku perustuu koodiin ja aikakatkaisut, uudelleenohjaukset ja uudelleenyritykset on määritettävä erikseen, käytä alla linkitettyä testattua Node.js-opasta. Yleisellä toiminnolla ja valmiilla sovelluksella voi olla eri siirron oletusasetukset.

Käsittele tulokset identified ja unknown sekä virheet erikseen

Jäsennä vastauksen runko ennen kuin valitset päivityksen kohdesovellukseen. Alla olevat JSON-polut viittaavat V2:n vastausrunkoon; alustasi voi kääriä tai litistää sen. Varmista todellinen palautettu rakenne harkitulla testillä ja pidä tulos liitettynä lähdetietueen tunnisteeseen.

Ennuste ei vahvista henkilön henkilöllisyyttä eikä hänen itse ilmoittamaansa sukupuolta. Säilytä se erillään tiedoista, jotka henkilö on itse antanut. Valitse hyväksymisehdot oman käyttötapauksesi näytön perusteella ja arvioi tietoaineiston ja tekoälyn luottamusarvot erikseen.

TarkistusOdotettu arvo tai tyyppiPäätös työnkulussa
meta.access.modeapi_key tämän tilin työnkulussaPysäytä, jos arvo on ip_trial, ja korjaa avain. Onnistunut kokeiluvastaus ei todista tilin todennusta, ja se on voinut jo kuluttaa kokeilun krediittejä.
meta.usage.billing_statusconfirmed tai unconfirmedJos arvo on unconfirmed, säilytä pyynnön tunniste ja pyydä laskutuksen täsmäytystä ennen uudelleenyritystä tai jatkamista.
data.result_status / data.genderidentified ja male tai female; unknown ja nullOhjaa hyväksytyt identified-tulokset erilliseen päätellyn tiedon kenttään. Säilytä unknown-tulokset antamatta niille oletusluokkaa.
data.confidence / data.confidence_kindluku väliltä 0–1 tai null; näytön tyyppi tai nullTulkitse arvot observed_frequency ja model_reported erikseen; kumpikaan ei ole yleinen tarkkuustakuu.
data.source / data.sample_countdataset, ai tai none / kokonaisluku tai nullSäilytä tieto siitä, miten ennuste saatiin. Tekoälytuloksella ei ole tallennettua otoskokoa, eikä tietoaineiston otoskoko ole tuotteen tarkkuuspistemäärä.
meta.request_id / meta.usagepyynnön tunniste / käyttötietojen objektiTallenna ne työnkulun tietueen ja tuloksen yhteyteen. Pidä API-avaimet ja tarpeettomat henkilötiedot poissa tavallisista lokeista.
HTTP-virhe / puuttuva vastausProblem Details tai ei täydellistä vastaustaKeskeytä päivitys ja tarkista virhe ja laskutuksen tila. Aikakatkaisu ei todista, ettei palvelin tehnyt mitään työtä.

Päivitä vain oikea Twilio SendGrid -tietue

Pidä käynnistimen palauttama yhteystiedon tunniste yhdessä jäsennetyn V2-rungon kanssa. Kun olet tehnyt alla olevat tulostarkistukset, päivitä vain tarkoitetut mukautetut kentät SendGrid-palvelussa. Säilytä yhteystiedon itse antama nimi; sähköpostiosoitteesta saatu data.name on päätelty ehdokas, ei vahvistettu korvaaja.

Testaa tuloksen identified, tuntemattoman tuloksen ja virheen haarat ennen päivitysten käyttöönottoa. Keksittyjen esimerkkivastausten avulla voit testata haarojen ehdot lähettämättä uutta ennustepyyntöä. Kohdesovelluksen päivitys saa tapahtua vain, kun yllä olevat tarkistukset täyttyvät, eikä se saa korvata muita kenttiä tai tunnisteita.

Hallitse uudelleenlähetyksiä ja toistuvia veloituksia

Pipedream dokumentoi tilauksesta riippuvat automaattiset uudelleenyritykset epäonnistuneesta vaiheesta alkaen. Tarkista nämä asetukset ja valitun HTTP-toiminnon mahdolliset uudelleenyritykset. Epäonnistuneen rikastusvaiheen uudelleenyritys voi aiheuttaa uuden veloituksen; myöhempi virhe kohdesovelluksessa on korjattava tallennetun rikastustuloksen avulla.

Jokainen uusi GenderAPI-pyyntö on itsenäinen toiminto. Poista päällekkäiset lähdetapahtumat omassa työnkulussasi ennen lähettämistä tallennetun lähdetunnisteen ja käsittelytilan avulla. Lähdetietueen tunniste ei ole palvelinpuolen avain, joka estäisi uudelleenlähetykset.

Onnistunut tuntematon tulos on valmis tulos, josta veloitetaan. Aikakatkaisun tai keskeneräisen vastauksen jälkeen sekä tulos että veloitus voivat olla epäselviä. Säilytä pyynnön tunniste, jos se on saatavilla, ja täsmäytä veloitus ennen uutta lähetystä. Noudata pyyntörajoitusvastauksen Retry-After-otsaketta, jos se on mukana.

Päätä, milloin tekoälyä käytetään

forceToGenderize on valinnainen nimille, sähköpostiosoitteille ja käyttäjänimille. Kun se on käytössä, jätä ai_mode pois tai käytä arvoa fallback; off ja always ovat ristiriidassa sen kanssa ja palauttavat 422-virheen. Positiivinen alkusaldo riittää pyynnön aloittamiseen, vaikka lopullinen veloitus painaisi saldon negatiiviseksi.

Lempinimitila voi palauttaa sukupuolen, vaikka tuloksessa on name: null. Se voi myös palauttaa tuntemattoman tuloksen. Tavallinen tekoäly varalla ja lempinimipäättely eivät takaa oikeaa vastausta eivätkä muuta kuin null-arvoista vastausta.

Pyynnön asetusToimintaKrediitit onnistuneesta hausta
options.ai_mode: offKäyttää vain tietoaineistoa.1, myös tuntemattomasta tuloksesta
options.ai_mode: fallbackHakee ensin tietoaineistosta ja käyttää tavallista tekoälyä, jos sukupuolta ei saada. Tämä on yksittäisen pyynnön oletus.Yhteensä 1, tekoäly varalla mukaan lukien
options.ai_mode: alwaysKäyttää suoraan tekoälyä.2
forceToGenderize: trueHakee ensin tietoaineistosta ja sallii sitten tekoälyn tulkita henkilökohtaisen lempinimen tai aliaksen myös ilman todellista etunimeä.1 tietoaineistosta ratkaistusta tuloksesta; yhteensä 2, jos tekoälyä käytetään

Varmista työnkulku ennen määrän kasvattamista

  • Tarkista yhdellä harkitulla testillä todellinen sarjallistettu JSON, jäsennetyn tuloksen polut, API-avaimella tapahtuva käyttö ja vahvistettu laskutus. Testaa unknown-tulosten ja virheiden ohjaus mahdollisuuksien mukaan valmiilla testivastauksilla.
  • Varmista, mitkä työnkulun vaiheet yrittävät uudelleen ja mitkä asiakkaan kentät muuttuvat. Säilytä lähdetietueen tunniste, valmis vastaus ja pyynnön tunniste, jotta myöhempi virhe kohdesovelluksessa ei vaadi uutta hakua.
  • Ota käyttöön pieni, valvottu ajo ja tarkista sen tietueet ja krediitit ennen kuin lisäät rinnakkaisuutta. GenderAPI-krediitit ja automaatioalustan tehtävä- tai toimintoveloitukset ovat erillisiä.
  • Käytä eräpyyntöön reittiä POST /api/v2/gender/batch: enintään 50 kohdetta API-avaimella tai 10 kohdetta IP-kokeilussa. Taulukossa items voi yhdistää nimiä, sähköpostiosoitteita ja käyttäjänimiä, ja jokaisella kohteella on erikseen määritetyt asetukset ja yksilöllinen id. Tarkista jokainen tulos; HTTP 200 -vastaus voi sisältää osittaisia virheitä. Valmiin liittimen eräpyyntötuki on tarkistettava erikseen.

Usein kysytyt kysymykset

Käyttääkö Pipedream-palvelun valmis GenderAPI.io-toiminto V2:ta?

Julkinen komponentti, joka tarkistettiin 26. syyskuuta 2026, käyttää vanhoja V1-endpointeja ja kyselyparametriin perustuvaa avaintodennusta. Käytä V2-pyyntöön erikseen määritettyä HTTP V2 -ohjetta, ja tarkista julkaistu komponentti uudelleen, jos sen versio muuttuu.

Salliiko suora HTTP-esimerkki tekoälyn käytön?

Ensimmäisen pyynnön runko asettaa kentän options.ai_mode arvoksi off. Vaihda arvo harkiten arvoon fallback, jos haluat tavallisen tekoälyn varalla yhteensä 1 krediitillä, tai arvoon always, jos haluat käyttää tekoälyä 2 krediitillä. forceToGenderize hakee ensin tietoaineistosta ja maksaa 1 krediitin, jos tulos ratkeaa siellä, tai yhteensä 2 krediittiä, kun tekoälyä käytetään.

Onko tuntematon tulos maksuton, tai onko sitä turvallista yrittää automaattisesti uudelleen?

Ei. Onnistunut tuntematon tulos on valmis ja veloitettava. Uusi yritys on uusi toiminto. Siirtovirheissä tai vahvistamattomassa laskutuksessa tarkista palautetut käyttötiedot ja pyynnön tunniste ennen kuin päätät lähettää pyynnön uudelleen.

Ajettiinko tämä työnkulku yhdistetyllä tilillä?

Ei. Alustojen määritysohjeet tarkistettiin julkista dokumentaatiota vasten 26. syyskuuta 2026. GenderAPI.io V2:n pyyntöä ja vastausta koskevat selitykset tarkistettiin 27. syyskuuta 2026. Tämän suomenkielisen version tarkistus 30. syyskuuta 2026 on käännöksen tarkistus eikä uusi testi tilillä. Testaa valitun toiminnon nykyiset kentät, todennus, runko, vastaus ja uudelleenyritykset omalla tililläsi ennen kuin otat päivitykset käyttöön tuotannossa.

Lähteet ja dokumentaatio

Suomenkielinen versio tarkistettiin viimeksi . Alustojen tiedot perustuvat niiden julkiseen dokumentaatioon, joka tarkistettiin 26. syyskuuta 2026. Tarkistus ei ollut uusi testi yhdistetyllä tilillä. Tarkista ajantasainen määritys ja saatavuus kunkin alustan virallisesta dokumentaatiosta.

Julkaistu: 22. heinäkuuta 2025Viimeksi tarkistettu:

Rakenna työnkulkusi

Tutustu V2-dokumentaatioon

Käy läpi parametrit ja vastaukset, jotta voit yhdistää kentät automaatiossasi.