| links.current | String | Link to navigate to the current page of results through the API | | links.previous | String | Link to navigate to the previous page of results through the API | | emsonpage | Number | Number of items returned in the data property of the response | | | String | Cursor to navigate to the next page of results through the API | | | String | Cursor to navigate to the current page of results through the API | | | String | Cursor to navigate to the previous page of results through the API | | limit | Number | No | Number of results to return. You can find cursors for next & previous pages in the meta.cursors property of the response. | cursor | String | No | Cursor to start from. Simply call the URL in links.next to get the next page of results. In the REST API you can also use the links from the response for added convenience. If is null you're at the end of the list. You will find the next cursor in the response body in. Afterwards you can fetch subsequent pages by providing a cursor parameter. To fetch the first page of results, call the list API without a cursor parameter. Apideck uses cursor-based pagination via the optional cursor and limit parameters. You can interact with the API through the authorization methods below.Īll API resources have support for bulk retrieval via list APIs. | Authorization | String | Yes | Bearer API KEY | | x-apideck-app-id | String | Yes | The application id of your Unify application. | x-apideck-raw | Boolean | No | Include raw response. Only needed when a customer has activated multiple integrations for the same Unified API. | x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). This can be a user id, account id, device id or whatever entity that can have integration within your app. | x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. Note that RFC7230 states header names are case insensitive. Use the GraphQL playground to test out the GraphQL API.Ĭustom headers that are expected as part of the request. We also provide a Mock API that can be used for testing purposes: It gives a verification code which you’ll need to get the access token like described in the Jira Tutorial.You can use this API to access all File Storage API endpoints. After approving the access, Jira will confirm that you have successfully authorized the access. Jira will ask, if you give the third-party app the permission to read and write content under your account. If the SecSignID plugin is set up correctly, your users will be able to authenticate via their SecSignID. The user needs to open the URL, in a browser or internal web view, to authenticate with Jira. After obtaining the request token from JIRA, you will get the access URL. Refer to the Jira Tutorial OAuth on how to obtain a request token with the example client. Follow the instructions to set up SecSignID in Jira: SecSignID Plugin needs to be installed in your Jira instance. You can find example clients in Perl, Php, Python, Ruby etc. The Jira Tutorial also offers an example client ( rest-oauth-client-1.0.one-jar.jar) in java. For REST API calls, only Oauth is supported. OAuth offers a collection of libraries and services that support OAuth 2.0 for common languages like Java, Php, Swift, Python, Ruby and so on.Īt the moment Oauth 2.0 is only available for Atlassian Connect add-ons. The third-party app or client can be in whatever language you prefer, it just needs to implement the OAuth protocol.
0 Comments
Leave a Reply. |