Criar cliente no Clockify, por uma API
Cria um cliente em um workspace. Exige name.
- Identificador
- clockify_create_client
A chamada
POST https://connect.reportei.com/api/tools/clockify_create_client/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"workspaceId": "<workspaceId>",
"name": "<name>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| workspaceId | string | Sim | Id of the workspace, from List workspaces or the activeWorkspace of Get current user. |
| name | string | Sim | Name of the client. |
| string | Não | Email of the client. | |
| address | string | Não | Address of the client. |
| note | string | Não | Notes about the client. |
Conexões possíveis
O seu cliente conecta a conta do Clockify uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {region}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/clockify_create_client. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Clockify
- Obter usuário atualGETRetorna o usuário conectado com seu id, que os argumentos userId aceitam, os ids dos workspaces ativo e padrão, o email e configurações como o fuso horário.
- Listar workspacesGETLista os workspaces do usuário conectado, com ids, nomes, moedas e valores por hora.
- Listar usuáriosGETLista os usuários de um workspace com ids, nomes e emails, 50 por página. Uma página com menos de 50 usuários é a última.
- Listar clientesGETLista os clientes de um workspace, 50 por página. Uma página com menos de 50 clientes é a última.
- Listar projetosGETLista os projetos de um workspace, arquivados ou não, 50 por página. Uma página com menos de 50 projetos é a última.
- Criar projetoPOSTCria um projeto em um workspace, opcionalmente para um cliente. Exige name.
- Listar tarefasGETLista as tarefas de um projeto, 50 por página. Uma página com menos de 50 tarefas é a última.
- Listar lançamentos de tempoGETLista os lançamentos de tempo de um usuário em um workspace, 50 por página. Uma página com menos de 50 lançamentos é a última. Com hydrated true, cada lançamento traz projeto, tarefa e tags em vez de só seus ids.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
