.png)
Integrate our service into your customer experience
Our developer-friendly API makes it easy for you and your customers to use all of our features inside your own system. You can also use a mix of API and our platform, where you let the recipient see their salary payments in the platform while you create the assignments in your platform via our API.
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.test.shoutly.com/partner/v1/collabs/14');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Accept' => 'application/json'
'Authorization': Bearer JWT_TOKEN
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.test.shoutly.com/partner/v1/collabs/14");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Authorization", "Bearer JWT_TOKEN");
xhr.send();{
"id": 14,
"owner": 7,
"employer": 7,
"gigger": 8,
"created_by_user": 7,
"accepted_by_user": null,
"date_start": "2021-04-21T22:00:00.000000Z",
"date_end": "2021-12-21T23:00:00.000000Z",
"upfront": 0,
"postpaid": 12,
"currency": "EUR",
"state": "Ongoing",
"cancellation": "sent_by_employer",
"deadline": 0,
"attest": 1,
"fee": "paid_together",
"email": null,
"invoice_id": 6,
"department_id": null,
"created_at": "2021-10-27T09:04:02.000000Z",
"updated_at": "2021-10-27T16:03:32.000000Z",
"extension": "none",
"suggested_date_end": null,
"frequency": "hourly",
"payout_date": null,
"payout_day": 26,
"cost_center": [],
"report": {
"id": 1,
"collab_id": 14,
"month": 9,
"year": 2021,
"state": "accepted",
"hours": 186,
"created_at": "2021-10-27T09:08:08.000000Z",
"updated_at": "2021-10-27T09:09:10.000000Z",
"cost_id": 41
},
"actions": {
"confirmation": 0,
"cancellation": 0,
"cancelButton": 0,
"extension": 0,
"extendButton": 1,
"finishNeeded": 1,
"finishReminder": 0,
"reportable": 0,
"approvable": 0,
"monthlyAttest": 0
},
"description": {
"describable_id": 14,
"describable_type": "App\Shoutly\Collabs\Collab",
"title": "Corporate Brand Specialist",
"description": null,
"attachments": null,
"satisfaction": null,
"deliverables": null,
"reason": null,
"asap": 0,
"sphere": null,
"work_category": null,
"experience_years": null,
"experience_level": null,
"location": null,
"employment_type": null,
"availability": null,
"max_price": null,
"working_hours": null,
"start_time": null,
"workfields": [],
"skills": [
"Adobe XDD"
]
},
"proposals": false,
"partner": {
"avatar": "http://www3.shoutly.test/v1/file/avatars/avatar-36.png",
"name": "Considine, Schroeder and Heathcote",
"email": "test@mail.com",
"country": "Sweden"
},
"department": null,
"fee_percent": 4
}01
Contact Us
Contact us and get access to the API documentation and an intro to how it can best be used for your purpose.
02
Create an account
Once you have access to the documentation, create an account, access the API keys and start testing.
03
Connect your giggers
When you are ready, you can connect your staff. If you use a combination of API and UI, they will receive an invitation to the platform.
04
Create collaboration, done!
You create collaborations through our API. The invoices to you will be triggered at the selected interval and then the payment will be sent.
