Byg på Tasked
Et REST API til projekter, opgaver, kunder, assets, review-kommentarer og webhooks. Alle svar indeholder et anmodnings-id og API-versionen; fejl deler samme format.
Autentificering
Alle anmodninger indeholder en organisations-API-nøgle som et bearer-token: Authorization: Bearer tsk_live_... En nøgle udstedes til én organisation med kun de nødvendige scopes og kan til enhver tid tilbagekaldes.
Opret og tilbagekald nøgler under Organisationsindstillinger på fanen Integrationer under API-nøgler. API'et er inkluderet i Business-planen.
Åbn organisationsindstillingerScopes
En nøgle indeholder en delmængde af disse scopes; en anmodning til et endpoint uden for disse afvises med 403.
- projects:read
- projects:write
- tasks:read
- tasks:write
- clients:read
- clients:write
- assets:read
- assets:write
- reviews:read
- webhooks:manage
Endpoints
| Metode | Sti | Hvad det gør | Scope |
|---|---|---|---|
| GET | /api/v1/me | The organization and scopes behind this key | projects:read |
| GET | /api/v1/openapi.json | This OpenAPI 3.1 document | Ingen nøgle påkrævet |
| GET | /api/v1/projects | List projects | projects:read |
| POST | /api/v1/projects | Create a project | projects:write |
| GET | /api/v1/projects/{id} | Get a project | projects:read |
| GET | /api/v1/tasks | List tasks | tasks:read |
| POST | /api/v1/tasks | Create a task | tasks:write |
| GET | /api/v1/tasks/{id} | Get a task | tasks:read |
| PATCH | /api/v1/tasks/{id} | Update a task | tasks:write |
| POST | /api/v1/tasks/{id}/move | Move a task to a stage | tasks:write |
| GET | /api/v1/clients | List clients | clients:read |
| POST | /api/v1/clients | Create a client | clients:write |
| GET | /api/v1/clients/{id} | Get a client | clients:read |
| GET | /api/v1/assets | List assets | assets:read |
| GET | /api/v1/assets/{id} | Get an asset | assets:read |
| POST | /api/v1/assets/uploads | Initiate a direct upload | assets:write |
| POST | /api/v1/assets/uploads/{id}/finalize | Confirm an upload and write the version | assets:write |
| GET | /api/v1/review-comments | List review comments on an asset | reviews:read |
| GET | /api/v1/webhooks | List webhooks | webhooks:manage |
| POST | /api/v1/webhooks | Create a webhook | webhooks:manage |
| GET | /api/v1/webhooks/{id} | Get a webhook | webhooks:manage |
| PATCH | /api/v1/webhooks/{id} | Update a webhook | webhooks:manage |
| DELETE | /api/v1/webhooks/{id} | Delete a webhook | webhooks:manage |
| GET | /api/v1/webhooks/{id}/deliveries | Delivery log of a webhook | webhooks:manage |
| POST | /api/v1/webhooks/{id}/deliveries/{deliveryId}/replay | Replay a delivery | webhooks:manage |
OpenAPI-dokument
De samme ruter, anmodningsstrukturer og svar som maskinlæsbar OpenAPI 3.1, genereret ud fra de validatorer, som API'et kører, så det ikke kan afvige fra dem.
Download openapi.jsonFejl og grænser
En fejl svarer med { error, errorCode, requestId, apiVersion }. En nøgle kan sende 600 anmodninger i minuttet; derover er svaret 429. Send X-API-Version for at fastlåse en version; en forældet version markeres i Deprecation-headeren.
Start uden kort
Fjorten dage, alt er slået til. Opret et workspace, fortæl AI'en, hvordan du arbejder, og inviter en kunde til at godkende.
Har du et spørgsmål? Skriv til os
Vi svarer direkte her på siden, når vi kan, og en medarbejder følger op, hvis der er brug for det. Ingen nyhedsbreve.