token_type: for Pix4D, this is always a Bearer token.access_token: the token value that you will have to join in all your requests.The response you receive when performing the authentication request above has the following content (In JSON): com /oauth2 /token / Token information Token content d "grant_type=client_credentials&token_format=jwt&client_id=YuB7fu…&client_secret=GMSVvt8dF…" \ client_secret: the client_secret of the application that was given to you by your Pix4D contact.client_id: the client ID of the application that was given to you by your Pix4D contact.The client must send the following HTTP POST request to with a payload containing: With this method, the authentication is straightforward and only requires the applications' client_id/client_secret pair Using this flow, an API client application can get access to its own Pix4D user account (and only to that account). Pix4D supports several of them that are each used for a specific purpose, but for PIX4Dengine Cloud customers, only one is relevant: "Client Credentials" Client Credentials flow OAuth 2.0 supports several "authentication flows" to retrieve an authentication token. The PIX4Dengine Cloud REST API uses OAuth 2.0, the industry standard for connecting apps and accounts. It is passed in the HTTP Authorization header, like so: Authorization : Bearer This token must then be passed along every single request that the application makes to the API. An authentication token identifies both the application connecting to the API and the Pix4D user this application is connecting on behalf of. API AuthenticationĮquipped with the API client_id/client_secret, the first step is to retrieve an authentication token. Note that as its name suggests, client_secret is a password identifying the client application and therefore should be handle securely. Please contact us at and we'll help you get set up and will give you a pair of client_id/client_secret that represents your application, the one that will connect to the API and that you will use to authenticate to the API. To register the application and start using the PIX4Dengine Cloud REST API you will need to acquire a PIX4Dengine Cloud license. Getting access to PIX4Dengine Cloud REST API The communication format is expected to be JSON, unless otherwise stated.Each REST API call needs to be authenticated.For end to end security, HTTPS is used in all the APIs.It allows a PIX4Dengine Cloud client to access his/her data on the cloud and perform a range of operations on them.
This document describes how to get started with the PIX4Dengine Cloud REST API, which provides third party applications access to the Pix4D cloud service. PIX4Dengine Cloud authentication procedure get Return the current logged in user information.del Delete the token with the provided `id`.
patch Update the project processing options.put Update the project processing options.post Set the project processing options.How to embed the complete 2D and 3D editor.How to retrieve inputs, outputs and reports.How to process a project with an existing.Create your project, upload the images and set and processing options