Download the PHP package chuckbe/dokapi-laravel-sdk without Composer
On this page you can find all versions of the php package chuckbe/dokapi-laravel-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package dokapi-laravel-sdk
Dokapi Laravel SDK
This package consumes the Dokapi API.
Installation
Publish
Publish the config file with:
Configuration & Environment
Make sure to set up your environment variables and modify where necessary.
Usage
Example:
Endpoints
Lookup
This endpoint is to lookup participants in the SML (or SMK - test).
Parameters:
- :: The participant identifier to lookup.
For scheme ‘iso6523-actorid-upis’ the values should adhere to the ‘ISO/IEC 6523’ standard with a semicolon seperator. See full list of ICD’s. The value is a combination of an International Code Designator (ICD) and an organization ID. For instance, for Belgian companies, the ICD value is 0208 and the organization ID is the KBO number. Example: 0208:0123456789
- :: This parameter specifies the identification scheme. It is optional and defaults to iso6523-actorid-upis.
Response:
Participant registration
This endpoint is to register and deregister participants their business cards and document types.
Page
This will a paginated list of participant registrations registered by this client.
Parameters:
- :: From what key shall participants be returned
- :: How many items on a page
Example:
Response:
All
This will get all participant registrations registered by this client.
Parameters:
- :: From what key shall participants be returned
- :: How many items should be returned
Example:
Response:
Find
This will search for a participant registration registered by this client. This will not perform a full lookup.
Parameters:
- :: The participant identifier to lookup.
For scheme ‘iso6523-actorid-upis’ the values should adhere to the ‘ISO/IEC 6523’ standard with a semicolon seperator. See full list of ICD’s. The value is a combination of an International Code Designator (ICD) and an organization ID. For instance, for Belgian companies, the ICD value is 0208 and the organization ID is the KBO number. Example: 0208:0123456789
- :: This parameter specifies the identification scheme. It is optional and defaults to iso6523-actorid-upis.
Example:
Response:
Create
This will create a participant registration for this client.
Parameters:
- :: The array should exist out of the participant identifier, the country code and the business card info.
Example:
Response:
Business card
This will perform a full replace of a participant's business card.
Parameters:
- :: The array should exist out of the participant identifier and the business card info.
Example:
Response:
Register document type
This will register a document type for a participant.
Parameters:
- :: The array should exist out of the participant identifier, document type identifier and the process identifier.
Example:
Response:
Deregister document type
This will deregister a document type for a participant.
Parameters:
- :: The array should exist out of the participant identifier and document type identifier.
Example:
Response:
Incoming document
Confirm download
This endpoint will confirm Dokapi of the download of a file.
Parameters:
- :: The document ulid that was given upon receival of the webhook.
Example:
Response:
Generate presigned url
This endpoint will generate a new pre signed url if the existing one has been expired.
Parameters:
- :: The document ulid that was given upon receival of the webhook.
Example:
Response:
Outgoing document
Create
This endpoint will create a new outgoing document.
Parameters:
- :: Look at example...
Example:
Response:
Webhook
All
This endpoint lists all webhooks registered.
Example:
Response:
Create
This endpoint creates a webhook, this can be for multiple events. Possible events: 'outgoing-peppol-documents.sent', 'incoming-peppol-documents.received', 'client.cancellation'.
Parameters:
- :: The data consisting of an url and an array of events.
Example:
Response: :: Response will contain a ulid string; store this, you'll need if you want to remove the webhook.
Delete
This endpoint deletes a webhook.
Parameters:
- :: The ulid of the webhook that you want to delete.
Example:
Response:
Secret
This endpoint generates a webhook secret. In case you need a new key, rerun this operation to invalidate the previous key and regenerate a new one.
Example:
Response: :: Store the message as the webhook secret key and use to validate webhooks.
All versions of dokapi-laravel-sdk with dependencies
ext-curl Version *
ext-json Version *
ext-openssl Version *
composer/ca-bundle Version ^1.2
illuminate/support Version ^8.0|^9.0|^10.0|^11.0|^12.0