Home

• Convenções
  • Parâmetros globais
    • Idioma
  • Documentação dos Parâmetros
    • Exemplo

Convenções

Parâmetros globais

Idioma

Ao usar o parâmetro locale na url com um idioma válido o sistema força as resposta pelo idioma selecionado.

Exemplo: https://pay.hashlee.com/v1/auth/login?locale=pt-br

Documentação dos Parâmetros

Para a documentação dos parâmetros de envio de um requisição se adotou o seguinte padrão:

name -> É o nome do parâmetro a ser enviado;

in -> Local onde é esperado o parâmetro;

Valores válidos:

• header: Enviado no header da requisição;
• formData: Enviado por meio de um formulário simples;
• query: Enviado via query string;
• path: Enviado de forma a compor a url completa, exemplo: https://pay.hashlee.com/v1/assets/b774dc17-3d15;

type -> Tipo do conteúdo enviado no parâmetro;

Valores válidos:

• string;
• boolean;
• number;
• date;
• datetime;
• array;
• list; (Para esse formato é requerido o parâmetro accepted)
• json (Para esse formato é requerido o parâmetro definition);

required -> Define se o parâmetro é ou não obrigatório;

example -> Apresenta um exemplo de valor para o parâmetro;

description -> Apresenta uma breve descrição para o parâmetro;

accepted -> Listagem de valores válidos para um determinado campo

definition -> Recebe um array de parâmetros com a definição dos mesmos e deve ser usado quando o tipo for json;

Exemplo

[
  {
    "name": "email",
    "in": "formData",
    "type": "string",
    "required": true,
    "example": "user@email.com",
    "description": "E-mail do usuário"
  },
  {
    "name": "addresses",
    "in": "formData",
    "type": "json",
    "required": false,
    "description": "Endereços do usuário",
    "definition": [
      {
        "name": "zip_code",
        "type": "string",
        "required": true,
        "description": "Código Postal",
        "example": "36700-000"
      },
      {
        "name": "address",
        "type": "string",
        "required": true,
        "description": "Endereço do usuário",
        "example": "Rua Tancredo Neves"
      }
    ]
  }
]