Download the PHP package confidencesapp/oktave-sdk-php without Composer
On this page you can find all versions of the php package confidencesapp/oktave-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package oktave-sdk-php
Oktave PHP SDK
This official PHP SDK for interacting with Oktave.
Installation
You can install the package manually or by adding it to your composer.json
:
Instantiating the SDK Client:
Pass in the configuration to the client:
Or configure after construct:
Note: if you are unsure what your client_id
, client_secret
or webhook_secret
are, please go to
your account and copy them.
For multiple teams users:
Pass in the team ID to the client:
Or configure after construct:
Attention! If no team
is specified, the team on which the OAuth client has been declared is used by default.
Note: if you are unsure what your team
is, please go to
your account and copy it.
Reset to the default team without its ID:
Note: the team value can be updated at anytime, for example between resource calls.
On-Premise Customers
If you are an on-premise customer and have your own infrastructure with your own domain, you can configure the client to use your domain:
Or by adding the api_endpoint
field to the $config
array you pass to the constructor.
Using the client
Multiple Resources
To return a list of your resources
Pagination
To return a paginated list of your resources
Single Resource by ID
Fetch a Resource by ID:
Handling Exceptions
Aside from errors that may occur due to the call, there may be other Exceptions thrown. To handle them, simply wrap your call in a try catch block:
Internally, there are several custom Exceptions which may be raised - see the Exceptions directory for more information.
Webhook request verification
To verify a webhook request signature
Test
Generate a coverage report: