Documentação da API

API Albion Desenvolvedor

Bem-vindo à documentação da API Albion Desenvolvedor. Aqui você encontrará informações sobre os endpoints, parâmetros, e exemplos de uso.

Visão Geral

A API da Albion Desenvolvedor oferece recursos abrangentes para consulta de dados de veículos, informações pessoais, envio de SMS e muito mais. Esta documentação detalha os endpoints, métodos, autenticação e exemplos práticos para integração eficaz.

Autenticação

Para utilizar a API, é necessário autenticação. Consulte a seção de autenticação para mais detalhes.

Como Solicitar Acesso à API Albion Desenvolvedor:

1. Conta na Albion Desenvolvedor:

Certifique-se de ter uma conta em https://albd.dev.br.

2. Acesse a Seção API:

Faça login em sua conta na Albion Desenvolvedor.

Vá para a seção API.

3. Solicite a Aprovação do Sistema:

Dentro da seção API, localize a opção "Solicitar Aprovação do Sistema".

Preencha os dados solicitados, incluindo informações sobre o seu sistema e seu site.

Envie a solicitação e aguarde a validação.

4. Aguarde a Validação:

Nossa equipe revisará sua solicitação e realizará uma avaliação do seu sistema.

Assim que aprovado, você receberá os tokens necessários para acessar a API.

5. Integre e Desenvolva:

Com os tokens em mãos, você estará pronto para integrar sua aplicação com a API Albion Desenvolvedor.

Exemplo de Requisição Autenticada

Autenticação pela URL:

URL: https://api.albd.dev.br

Autenticação pela URL:

https://api.albd.dev.br/?systemAuth=SEU_SYSTEM_AUTH&userToken=SEU_USER_TOKEN

Autenticação pelo Cabeçalho (Token):

Endpoint: https://api.albd.dev.br/

Autenticação pelo Cabeçalho:

curl -X GET "https://api.albd.dev.br/?userToken=SEU_USER_TOKEN" \ -H "Authorization: Bearer SEU_SYSTEM_AUTH"

Essa página HTML mostra exemplos de como autenticar uma requisição pela URL e pelo cabeçalho. Lembre-se de substituir os marcadores de posição (SEU_SYSTEM_AUTH, SEU_USER_TOKEN, SEU_TOKEN_DE_ACESSO) pelos valores reais da sua autenticação.

Mensagens Exibidas:

Código Texto
0 Não Encontramos
1 Sucesso
2 Falha Parcial
3 Tivemos uma falha interna, tente novamente em alguns minutos
4 Tem dados Faltando, por favor leia nossa documentação.
5 Token inválido
6 Serviço Indisponível
7 Saldo insuficiente
8 Acesso Negado
9 Conta Inativa
10 Estamos Atualizando nosso sistema.
11 Token Expirado
12 Concluído
13 Aguardando Pagamento da Consulta
14 Pagamento já concluído Antes

Exemplo de Resposta da API:

[{
  "status": "1",
  "lang": 0,
  "version": "1",
  "msg": {
    "msg": "Sucesso",
    "extra": "https://view.albd.dev.br/?id=C-30&token=1299D927"
  },
  "dados": [
    {
      "MensagemRetorno": "Funcionalidade indisponível.",
      "StatusRetorno": "10",
      "ParametroPesquisa": "JRJ1D28",
      "TipoParametro": "Placa"
    }
  ]
}]
        

Explicação dos Parâmetros:

  • status: Código de status da resposta.
  • lang: Idioma da resposta.
  • version: Versão da API.
  • msg: Objeto contendo a mensagem de retorno.
  • dados: Array de dados retornados pela API.

Exemplo de Endpoint: Pesquisa placa na Base Nacional

https://api.albd.dev.br/service/f/3/8/placa?SEU_SYSTEM_AUTH&userToken=SEU_USER_TOKEN

Lista de Serviços API

ID Nome Descrição Tipo Categoria Parâmetro Quantidade de Parâmetros Endpoint
1

Serviços Albion Desenvolvedor

A Albion Desenvolvedor oferece uma variedade de serviços para atender às suas necessidades de comunicação e atendimento ao cliente.

Compra de Números

Adquira números virtuais para utilizar em seus projetos, seja para receber chamadas telefônicas ou mensagens SMS.

Criação de Central de Atendimento

Desenvolva uma central de atendimento personalizada para interagir com seus clientes, proporcionando uma experiência única.

Envio de SMS e Ligações

Utilize nossos serviços para enviar mensagens SMS e realizar chamadas telefônicas. Lembre-se de que o acesso a ligações depende dos créditos disponíveis em sua conta e do plano escolhido.

Contate-nos para mais informações e descubra como a Albion Desenvolvedor pode impulsionar a comunicação e o atendimento em seus projetos.

Exemplo de Envio de SMS com a API Albion Desenvolvedor

Utilize o código abaixo como exemplo para enviar um SMS através da API da Albion Desenvolvedor. Lembre-se de substituir os parâmetros conforme necessário.

    
        const numeroDestino = "119xxxx6744"; // Número de destino (DDI + DDD + Número)
        const textoMensagem = "Exemplo de mensagem SMS."; // Texto da mensagem (máximo de 160 caracteres)

        const textoMensagemCodificado = encodeURIComponent(textoMensagem);

        const endpoint = `https://api.albd.dev.br/voip/sms/${numeroDestino}/${textoMensagemCodificado}?systemAuth=SEU_SYSTEM_AUTH&userToken=SEU_USER_TOKEN`;

        // Faça a requisição para o endpoint utilizando a biblioteca adequada (ex: axios, fetch).
    

Certifique-se de substituir o numeroDestino pelo número de telefone de destino desejado e o textoMensagem pela mensagem que deseja enviar. Lembre-se de codificar o texto da mensagem como uma URL.

Ao enviar a requisição para o endpoint fornecido, você poderá receber um status de retorno, sendo 1 para conclusão ou 12 para mensagem entregue.