Entenda onde encontrar cada informaĆ§Ć£o na API Reference e como utilizĆ”-la para realizar e validar suas requisiƧƵes.
Esta pĆ”gina foi criada para ajudar vocĆŖ a entender como navegar pela API Reference dos Plugins da BigDataCorp. Aqui, vocĆŖ encontrarĆ” orientaƧƵes sobre:
- Onde localizar cada informaĆ§Ć£o dentro das pĆ”ginas de endpoint,
- Como identificar rapidamente os elementos necessĆ”rios para a integraĆ§Ć£o, e
- Como utilizar o console interativo para realizar e validar chamadas diretamente pela documentaĆ§Ć£o.
O objetivo Ć© facilitar sua navegaĆ§Ć£o, permitindo explorar, testar e implementar integraƧƵes com as APIs da BigDataCorp de forma mais simples, rĆ”pida e eficiente.
š Guia rĆ”pido: onde encontrar cada informaĆ§Ć£o
| InformaĆ§Ć£o | Onde encontrar |
|---|---|
| Nome do dataset/tecnologia/plugin | TĆtulo da pĆ”gina |
| Endpoint e mĆ©todo HTTP | Logo abaixo do tĆtulo |
| DescriĆ§Ć£o do dataset/tecnologia/plugin | SeĆ§Ć£o DescriĆ§Ć£o, no centro da pĆ”gina |
| Regras de preƧo | SeĆ§Ć£o Tabela de preƧos, no centro da pĆ”gina |
| Outras informaƧƵes relevantes (quando aplicƔvel) | Logo abaixo da Tabela de preƧos |
| Linguagens de programaĆ§Ć£o de exemplo | Seletor Language, no canto superior direito |
| Inserir as credenciais da API | SeĆ§Ć£o Credentials, no canto superior direito |
| Exemplo de requisiĆ§Ć£o | Console cURL Request, quadro preto no canto superior direito |
| Resultado da chamada e exemplo de resultado | Ćrea de resposta do console, abaixo do quadro preto da direita |
| HistĆ³rico de chamadas executadas utilizando o Console | SeĆ§Ć£o Recent Requests, no final da pĆ”gina |
| ParĆ¢metros da requisiĆ§Ć£o | SeĆ§Ć£o Body Params, no final da pĆ”gina |
| Estrutura da resposta, com descriĆ§Ć£o dos campos principais | SeĆ§Ć£o Response, no final da pĆ”gina |
š InformaƧƵes gerais
Na regiĆ£o central da pĆ”gina, vocĆŖ encontra as principais informaƧƵes para entender o contexto da API e como utilizĆ”-la.
PƔgina de endpoint: informaƧƵes gerais
Aqui vocĆŖ encontra:
- Nome do dataset, tecnologia ou plugin
- MĆ©todo HTTP e endpoint da requisiĆ§Ć£o
- DescriĆ§Ć£o funcional da API
- Tabela de preƧos
- InformaƧƵes adicionais (quando aplicƔvel)
Use essa seĆ§Ć£o para entender rapidamente o que a API faz, quando utilizĆ”-la e quais sĆ£o suas regras de consumo.
š» Exemplo de requisiĆ§Ć£o e retorno
No painel lateral direito, vocĆŖ encontra o console interativo da API.
PĆ”gina de endpoint: console de requisiĆ§Ć£o
Aqui vocĆŖ pode:
- Visualizar o cĆ³digo da requisiĆ§Ć£o pronto para uso
- Selecionar a linguagem de integraĆ§Ć£o desejada (Shell, Node, Ruby, PHP, Python etc.)
- Copiar e adaptar o cĆ³digo para sua aplicaĆ§Ć£o
- Executar a chamada diretamente pela documentaĆ§Ć£o
Logo abaixo do console, estƔ a Ɣrea de resposta.
PƔgina de endpoint: Ɣrea de retorno da chamada
Nessa seĆ§Ć£o, vocĆŖ pode:
- Visualizar exemplos de retorno com e sem dados (quando disponĆvel)
- Validar o resultado da sua chamada
- Copiar o retorno para testes e desenvolvimento
š§© Campos e tipos de retorno
Ao final da pĆ”gina, a seĆ§Ć£o Response apresenta a estrutura detalhada do retorno da API.
PƔgina de endpoint: campos da resposta, tipos de retorno e descriƧƵes
Aqui vocĆŖ pode:
- Identificar os campos retornados
- Ver o tipo de dado de cada campo
- Entender o significado de cada informaĆ§Ć£o
- Explorar campos adicionais expansĆveis (quando disponĆveis)
Use essa seĆ§Ć£o para implementar corretamente o tratamento da resposta na sua integraĆ§Ć£o.
ā¶ļø Fazendo uma requisiĆ§Ć£o pela documentaĆ§Ć£o
VocĆŖ pode testar a API diretamente pela API Reference.
PĆ”gina de endpoint: fazer uma requisiĆ§Ć£o pela documentaĆ§Ć£o
Siga os passos abaixo:
- Preencha os parĆ¢metros na seĆ§Ć£o Body Params
- Insira suas credenciais de acesso em Credentials
- Selecione a linguagem desejada
- Clique em Try It para executar a requisiĆ§Ć£o
- Visualize o resultado na seĆ§Ć£o Response, logo abaixo do console.
š HistĆ³rico de requisiƧƵes
Na seĆ§Ć£o Recent Requests, ao final da pĆ”gina, vocĆŖ pode acompanhar as chamadas realizadas.
PĆ”gina de endpoint: histĆ³rico de requisiƧƵes
Use essa Ɣrea para:
- Revisar requisiƧƵes executadas
- Validar respostas anteriores
- Apoiar testes e depuraĆ§Ć£o