Diversos endpoints da API utilizam identificadores únicos (id) para realizar consultas, atualizações e integrações dentro da plataforma.
Esses IDs podem representar diferentes recursos, como:
- Boards
- Cards
- Registros
- Formulários
- Campos
- Usuários
- Fases
- Entre outros
Alguns ID's presentes na lista, você consegue obtendo com outras consultas, irei mostrar como obter as mais simples para obter as mais complexas
🖼 ✉ Obtendo o ID de um Board
O ID do Board pode ser encontrado diretamente pela URL ao acessar o quadro desejado.
Como localizar?
- Acesse o menu de Boards da plataforma.
- Abra o Board desejado.
- Observe a URL exibida no navegador.
Exemplo:
https://app.goalfy.com.br/boards/12345
Neste Exemplo:
12345 é o ID do Board.
🖼 ✉ Obtendo o ID de um Card
Cada Card possui um identificador único utilizado em diversos endpoints da API.
Como localizar?
- Acesse o Board desejado.
- Abra o Card que deseja consultar.
- Observe a URL exibida no navegador.
Exemplo:
https://app.goalfy.com.br/card/98765
Neste exemplo:
98765 corresponde ao ID do Card.
🏦🎲 Obtendo o ID de uma Database
As databases também possuem identificadores únicos que podem ser utilizados em consultas via API.
Como localizar?
- Acesse o módulo onde se localiza as databases.
- Abra a Database desejado.
- Verifique a URL da página.
Exemplo:
https://app.goalfy.com.br/register/45678
Neste exemplo:
45678 é o ID do Database.
🏦🎲 Obtendo o ID de um Registro
Os registros também possuem identificadores únicos que podem ser utilizados em consultas via API.
Como localizar?
- Acesse o módulo onde o registro está localizado.
- Abra o registro desejado.
- Verifique a URL da página.
Exemplo:
https://app.goalfy.com.br/register/90244
Neste exemplo:
90244 é o ID do registro.
🔎 Observações importantes
- Os IDs são únicos dentro da plataforma.
- Alguns endpoints exigem IDs específicos para funcionamento correto.
- Certifique-se de utilizar o ID correspondente ao recurso solicitado pelo endpoint.
- IDs incorretos ou inexistentes podem retornar erros como 404 Not Found.
⚙📃Dicas para integrações
Durante o desenvolvimento de integrações, recomenda-se:
- Salvar IDs importantes em variáveis ou configurações.
- Validar os IDs antes de realizar requisições.
- Utilizar endpoints de listagem para localizar recursos dinamicamente quando necessário.
Isso ajuda a tornar sua integração mais segura, organizada e escalável.