Documentação da API Unified API v2.0

API v1.0

Nós também oferecemos outra versão de API com pontos de extremidade que são mais fáceis de integrar. Se você é um iniciante na implementação de APIs, pode mudar para o nosso ponto de extremidade v1.0.

Ver API v1.0

OpenAPI

Veja nossa documentação da API no Swagger

Postman

Importe nossa definição de API para o Postman

Consultar por primeiro nome

Consulta por Nome Completo

Consulta por endereço de e-mail

Obter País de Origem

Obter Estatísticas

Códigos de erro

endpoint-not-found

Status	endpoint-not-found
HTTP Status Code	404
Description	API endpoint not found

limit-exceeded

Status	limit-exceeded
HTTP Status Code	401
Description	Limit exceeded. Thank you for using our service. Please consider to buy more requests.

parameter-first-name-invalid

Status	parameter-first-name-invalid
HTTP Status Code	400
Description	The "first_name" parameter is invalid. The parameter can only be a string with a length from 1 to 50 chars.

parameter-full-name-invalid

Status	parameter-full-name-invalid
HTTP Status Code	400
Description	The "full_name" parameter is invalid. The parameter can only be a string with a length from 3 to 100 chars.

parameter-email-invalid

Status	parameter-email-invalid
HTTP Status Code	400
Description	The "email" parameter is invalid. The parameter can only be a string with a length from 3 to 100 chars and must be a valid email address.

key-parameter-missing

Status	key-parameter-missing
HTTP Status Code	400
Description	The "key" parameter is not set. Please create an account to fetch an API key.

invalid-key

Status	invalid-key
HTTP Status Code	400
Description	Invalid API key. You can find your personal API key in your account.

invalid-country-code

Status	invalid-country-code
HTTP Status Code	400
Description	The given country code is not valid. You can find a list of valid country codes in our API docs.

invalid-ip-address

Status	invalid-ip-address
HTTP Status Code	400
Description	The given ip address is not valid. Please provide either a valid IPv4 or an IPv6 address.

generic-error

Status	generic-error
HTTP Status Code	400
Description

invalid-json

Status	invalid-json
HTTP Status Code	400
Description

invalid-locale

Status	invalid-locale
HTTP Status Code	400
Description	The given locale is not valid. You can find a list of valid country codes in our API docs.

invalid-id

Status	invalid-id
HTTP Status Code	400
Description	The given id is not valid. An id can be either an integer or a string with 50 chars at max.

mandatory-parameter-missing

Status	mandatory-parameter-missing
HTTP Status Code	400
Description	Mandatory parameter missing. Either first_name, full_name or email must be set.

content-type-missing

Status	content-type-missing
HTTP Status Code	400
Description	Content-Type missing. Please add a "Content-Type: application/json" to your API call.

missing-json

Status	missing-json
HTTP Status Code	400
Description	We weren't able to find a json body in your API call. Please make sure the body is sent with a POST request to our API endpoint.

too-many-queries

Status	too-many-queries
HTTP Status Code	400
Description	Too many queries in a single API call.

too-many-queries-api-key

Status	too-many-queries-api-key
HTTP Status Code	400
Description	Too many queries in a single API call. Your API key is limited to 3 lookups per request.

authorization-header-missing

Status	authorization-header-missing
HTTP Status Code	400
Description	Your query misses the "Authorization" header with the bearer token.

invalid-auth-token

Status	invalid-auth-token
HTTP Status Code	400
Description	Invalid authentication token provided. Please log in to your account to find a list of valid tokens or to create a new one.

email-invalid

Status	email-invalid
HTTP Status Code	400
Description	Invalid or empty email address given.

password-invalid

Status	password-invalid
HTTP Status Code	400
Description	Invalid credentials. Login failed. Please also check your account that third-party app access is not restricted.: https://gender-api.com/de/account/password

label-invalid

Status	label-invalid
HTTP Status Code	400
Description	Invalid label given. A label must be a string between 2 and 30 chars.

email-account-not-found

Status	email-account-not-found
HTTP Status Code	400
Description	No Gender-API.com account found. Please create a free account first, to sign-in with Google or try to login with an existing username or password.

invalid-list-of-names

Status	invalid-list-of-names
HTTP Status Code	400
Description	Invalid list of names. Expected array of strings.

Este produto inclui dados GeoLite2 criados pela MaxMind, disponíveis em http://www.maxmind.com.