API Reference

Criação do Lead

Este endpoint inicia o cadastro do Lead quando chamado pelo provedor e repassadas as informações básicas necessárias.

A API retorna lead_id e o onboarding_url que é o link da continuação do processo de cadastro para o usuário finalizar, sendo responsabilidade do provedor direcionar o usuário para o fluxo seguinte.

Antes de tudo é necessário passar o header de autorização com o valor do token obtido anteriormente, como demonstrado:

Abaixo está exemplificado como deve ser feita a requisição à API GraphQL do Onboarding, sendo obrigatório passar todos os campos: 

// Corpo da requisição
{
    "query": "mutation createLeadMutation {\n  createLead(input: {business_corporate_name: \"pagaleve\", business_number: \"81844446565\", email: \"[email protected]\", phone_number: \"+552199999999\", provider: \"wbuy\", provider_creation_date: \"2022-01-12\", redirect_url: \"http://www.google.com.br\"}) {\n    lead_id\n    onboarding_url\n  }\n}\n",
    "variables": null,
    "operationName": "createLeadMutation"
}

A resposta da requisição é a confirmação do cadastro como Lead, seguindo o formato abaixo:

cURL: Quando tiver o access_token substituir em authorization

curl "https://stage-onboarding-api.pagaleve.io/graphql" ^
  -H "authorization: {HEADER_AUTHORIZATION}" ^
  -H "content-type: application/json" ^
  --data-raw "^{^\^"query^\^":^\^"mutation createLeadMutation ^{^\^\n  createLead(input: ^{business_corporate_name: ^\^\^\^"pagaleve^\^\^\^", email: ^\^\^\^"pagaleve^@pagaleve.com.br^\^\^\^", business_number: ^\^\^\^"81844446565^\^\^\^", phone_number: ^\^\^\^"+552199999999^\^\^\^", provider: ^\^\^\^"wbuy^\^\^\^", provider_creation_date: ^\^\^\^"2022-01-12^\^\^\^", redirect_url: ^\^\^\^"https://www.pagaleve.com.br^\^\^\^"^}) ^{^\^\n    lead_id^\^\n    onboarding_url^\^\n  ^}^\^\n^}^\^\n^\^",^\^"variables^\^":null,^\^"operationName^\^":^\^"createLeadMutation^\^"^}" ^
  --compressed

Parâmetros de produção

URL: https://onboarding-api.pagaleve.com.br/graphql

Schema:

type OnboardingStartResult {
  lead_id: String!
  onboarding_url: String!
}

input CreateLeadInput {
  business_number: String
  business_corporate_name: String
  email: String!
  phone_number: String
  provider_creation_date: String!
  redirect_url: String!
  provider: String!
  metadata: AWSJSON
}

type Mutation {
  createLead(input: CreateLeadInput): OnboardingStartResult!
}

type Query {
  dummy: AWSJSON
}

schema {
  query: Query
  mutation: Mutation
}

Parâmetros

  • business_number: Possui validação para aceitar apenas CNPJ/CPF
  • business_corporate_name: Deve conter o nome da empresa e não pode ser uma string vazia
  • email: Verifica se é um e-mail válido
  • phone_number: Valida se é um número de telefone válido
  • provider_creation_date: Este campo armazena a data que foi criado o cadastro, pode ser apenas a data
  • redirect_url: Verifica se é uma Url válida
  • provider: Valida se é um provedor permitido
  • metadata: Objeto no formato JSON (Opcional)
  • lead_id: É um ID válido atralado ao usuário
  • onboarding_url: É uma Url válida que vai redirecionar o usuário para completar o cadastro