Skip to content

Commit

Permalink
STD-1 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
2lives committed Apr 22, 2024
1 parent 551de8d commit 41a33d9
Showing 1 changed file with 2 additions and 13 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ $job = $api->createJob($jobPayload);

// UPLOAD JOB PHOTO(S)
$filePath = '/path/to/photo';
$api->uploadJobPhoto($filePath, $job->id);
$api->uploadJobPhoto($filePath, $job['id']);

// QUEUE JOB
$payload = [ 'callback_url' => 'YOUR_CALLBACK_ENDPOINT' ];
$api->queueJob(job.id, $payload);
$api->queueJob($job['id'], $payload);

// NOTE: Once the job is queued, it will transition to processed and then completed
// We will send a response to the specified callback_url with the output photo download urls
Expand Down Expand Up @@ -181,17 +181,6 @@ $api->getPhoto($photoId);
$api->deletePhoto($photoId);
```

### Validate HMAC Headers

- secretKey: Obtained from Skylab account (contact)
- jobJson: Raw JSON response from callback
- requestTimestamp: Timestamp header received in callback under 'X-Skylab-Timestamp'
- signature: Signature header received in callback under 'X-Skylab-Signature'

```php
$api->validateHmacHeaders($secretKey, $jobJson, $requestTimestamp, $signature);
```

## Troubleshooting

### General Troubleshooting
Expand Down

0 comments on commit 41a33d9

Please sign in to comment.