Rakenna Tasked-alustalle
REST API projekteille, tehtäville, asiakkaille, tiedostoille, katselmointikommenteille ja webhookeille. Jokainen vastaus sisältää pyyntötunnuksen ja API-version; virheet jakavat saman rakenteen.
Autentikointi
Jokainen pyyntö sisältää organisaation API-avaimen bearer-tokenina: Authorization: Bearer tsk_live_... Avain luodaan yhdelle organisaatiolle vain sen tarvitsemilla oikeuksilla, ja se voidaan mitätöidä milloin tahansa.
Luo ja mitätöi avaimia organisaation asetuksista Integraatiot-välilehdeltä kohdasta API-avaimet. API sisältyy Business-pakettiin.
Avaa organisaation asetuksetOikeudet
Avain sisältää osan näistä oikeuksista; pyyntö niiden ulkopuoliseen päätepisteeseen hylätään virhekoodilla 403.
- projects:read
- projects:write
- tasks:read
- tasks:write
- clients:read
- clients:write
- assets:read
- assets:write
- reviews:read
- webhooks:manage
Päätepisteet
| Metodi | Polku | Kuvaus | Oikeus |
|---|---|---|---|
| GET | /api/v1/me | The organization and scopes behind this key | projects:read |
| GET | /api/v1/openapi.json | This OpenAPI 3.1 document | Avainta ei tarvita |
| 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-dokumentti
Samat reitit, pyyntörungot ja vastaukset koneluettavana OpenAPI 3.1 -muodossa, luotuna suoraan API:n käyttämistä validaattoreista, joten se ei voi poiketa niistä.
Lataa openapi.jsonVirheet ja rajoitukset
Virhe palauttaa vastauksen { error, errorCode, requestId, apiVersion }. Avain voi lähettää 600 pyyntöä minuutissa; sen ylittyessä vastaus on 429. Lähetä X-API-Version lukitaksesi tietyn version; vanhentunut versio merkitään Deprecation-otsakkeessa.
Aloita ilman korttia
Neljätoista päivää, kaikki ominaisuudet käytössä. Avaa työtila, kerro AI:lle miten työskentelet ja kutsu asiakas hyväksymään.
Kysyttävää? Kirjoita meille
Vastaamme suoraan sivustolta, kun pystymme, ja ihminen jatkaa tarvittaessa. Ei postituslistoja.