Download the PHP package rishimohan/orshot without Composer
On this page you can find all versions of the php package rishimohan/orshot. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rishimohan/orshot
More information about rishimohan/orshot
Files in rishimohan/orshot
Package orshot
Short Description Orshot API SDK for PHP
License MIT
Homepage https://orshot.com
Informations about the package orshot
Orshot API PHP SDK
View on Packagist: https://packagist.org/packages/rishimohan/orshot
Installation
Usage
If you don't have your API key, get one from orshot.com
renderFromStudioTemplate
Render from a custom Studio template. Supports image, PDF, video generation and publishing to social accounts.
Generate Image
Generate PDF
Generate Video
Publish to Social Accounts
Schedule a Post
Parameters
| key | required | description |
|---|---|---|
templateId |
Yes | ID of the Studio template (integer). |
modifications |
No | Array of dynamic modifications for the template. |
response.type |
No | base64, binary, url (Defaults to url). |
response.format |
No | png, webp, jpg, jpeg, pdf, mp4, webm, gif (Defaults to png). |
response.scale |
No | Scale of the output (1 = original, 2 = double). Defaults to 1. |
response.includePages |
No | Page numbers to render for multi-page templates (e.g. [1, 3]). |
response.fileName |
No | Custom file name (without extension). Works with url and binary types. |
pdfOptions |
No | { margin, rangeFrom, rangeTo, colorMode, dpi } |
videoOptions |
No | { trimStart, trimEnd, muted, loop } |
publish.accounts |
No | Array of social account IDs from your workspace. |
publish.content |
No | Caption/text for the social post. |
publish.isDraft |
No | true to save as draft instead of publishing. |
publish.schedule.scheduledFor |
No | ISO date string to schedule the post. |
publish.timezone |
No | Timezone string (e.g. "America/New_York"). |
publish.platformOptions |
No | Per-account options keyed by account ID. |
renderFromTemplate
Render from a pre-built Orshot template.
| key | required | description |
|---|---|---|
templateId |
Yes | ID of the template (open-graph-image-1, tweet-image-1, etc.) |
modifications |
Yes | Modifications for the selected template. |
responseType |
No | base64, binary, url (Defaults to url). |
responseFormat |
No | png, webp, pdf, jpg, jpeg (Defaults to png). |
For available templates and their modifications refer Orshot Templates Page
generateSignedUrl
Generate a signed URL for a template.
| key | required | description |
|---|---|---|
templateId |
Yes | ID of the template. |
modifications |
Yes | Modifications for the selected template. |
expiresAt |
Yes | Expires at in unix timestamp (Number). |
renderType |
No | images, pdfs (Defaults to images). |
responseFormat |
No | png, webp, pdf, jpg, jpeg (Defaults to png). |
Local development and testing
Run these from the project root
composer config repositories.local '{"type": "path", "url": "/path/to/your/library"}' --global
Update the url to the path of the library in your computer.
In a separate test directory, run this
composer require rishimohan/orshot:@dev
Write a small PHP script test.php in the test directory using the above exposed functions and run php test.php