Download the PHP package apruvd/php_sdk_v4 without Composer
On this page you can find all versions of the php package apruvd/php_sdk_v4. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download apruvd/php_sdk_v4
More information about apruvd/php_sdk_v4
Files in apruvd/php_sdk_v4
Package php_sdk_v4
Short Description Lightweight PHP SDK for integrating with the Apruvd API v4.
License MIT
Homepage https://v4-dev.apruvd.com/docs/
Informations about the package php_sdk_v4
apruvd-v4-php
Lightweight PHP SDK for integrating with the Apruvd API v4
Services
APIService
The main primary service containing 1:1 method mapping on available API endpoints.
APIAsyncResponseService
The optional service to grab/transform $_POST JSON
data into the appropriate response model. The
Authentication
There are 2 viable authentication patterns for the v4 API, API Keys and OAuth 2.0
API Keys
Consisting of a key/secret pairthat is generated in the application settings page. Used as a basic authentication scheme. All calls can be made using this key key set - using the OAuth 2.0 flow is completely option
OAuth 2.0
This method uses two tokens, an access token and a refresh token. Using your API Key, you can get a refresh token. You can then use that token to create an access token, which should then be used during requests to authenticate. Note that access tokens expire more quickly than refresh tokens, but both will expire in time.
Using your API Key you can programatically request a refresh token using the following method:
A token set will be returned and automatically binded to the service class. When new tokens are generated an optional anonymous callback function can be passed to the API service as an event handler.
If a refresh token has been binded via service constructor, subsequent API calls will automatically request a new access token on missing or failed attempts. This process can additionally be handled via direct call.
It's recommended that the onAccessTokenUpdate method be used with your prefered storage routine and that the refresh and access tokens can be recalled and passed via service constructor.
Models
Transaction and Cart Contents
For model details please refer to the codebase and the API docs. All model types can take object/array property sets for constructor hydration.
Responses
All responses are well formed and documented. The following properties of the APIModel class are available to all responses, with each response binding it's own additional properties.
-
- integer | HTTP Response Code
-
- string | Possible 400/500 error response message
-
- boolean | Was HTTP within 200 range
-
- object | Possible 400 validation error response messages. Nested Object.
-
- Httpful\Response | Fully formed response from Httpful service. Useful for debugging.
API Methods and Endpoints
readMerchants(String $id) : ReadMerchantsResponse
Submits to as GET
createMerchantAccessToken() : CreateMerchantAccessTokenResponse
Submits to as POST
createMerchantRefreshToken() : CreateMerchantRefeshTokenResponse
Submits to as POST
listWebhookAPIKeys(int $page, int $page_size) : ListWebhookAPIKeysResponse
Submits to as GET
createWebhookAPIKey(WebhookAPIKey $webhook_api_key) : UpsertWebhookAPIKeyResponse
Submits to as POST
readWebhookAPIKey(String $id) : ReadWebhookAPIKeyResponse
Submits to as GET
updateWebhookAPIKey(String $id, WebhookAPIKey $webhook_api_key) : UpsertWebhookAPIKeyResponse
Submits to as PUT
partialUpdateWebhookAPIKey(String $id, WebhookAPIKey $webhook_api_key) : UpsertWebhookAPIKeyResponse
Submits to as PATCH
deleteWebhookAPIKey(String $id) : APIResponse
Submits to as DELETE
listWebhooks(int $page, int $page_size) : ListWebhooksResponse
Submits to as GET
createWebhook(Webhook $webhook) : UpsertWebhookResponse
Submits to as POST
readWebhook(String $id) : ReadWebhookResponse
Submits to as GET
updateWebhook(String $id, Webhook $webhook) : UpsertWebhookResponse
Submits to as PUT
partialUpdateWebhook(String $id, Webhook $webhook) : UpsertWebhookResponse
Submits to as PATCH
deleteWebhook(String $id) : APIResponse
Submits to as DELETE
createTransaction(Transaction $transaction) : UpsertTransactionResponse
Submits to as POST
readOrderByID(String $id) : ReadTransactionResponse
Submits to as GET
updateOrderByID(String $id, Transaction $transaction) : UpsertTransactionResponse
Submits to as PUT
partialUpdateOrderByID(String $id, Transaction $transaction) : UpsertTransactionResponse
Submits to as PATCH
createSession(Session $session) : CreateSessionResponse
Submits to as POST
updateSession(String $id, Session $session) : UpsertSessionResponse
Submits to as PUT
partialUpdateSession(String $id, Session $session) : UpsertSessionResponse
Submits to as PATCH
Helper Methods
onAccessTokenUpdate(Closure $callback)
Registers the single event handler for Token Update events. This maps to a single property, only one callback per event cycle.