screenshots.md

Screenshots API

List screenshots

https://app.lokalise.com/api2docs/curl/#transition-list-all-screenshots-get

$response = $client->screenshots->list(
    $projectId,
    [
        'limit' => 20,
        'page' => 1,
    ]
);

$response = $client->screenshots->fetchAll($projectId);

Create screenshots

https://app.lokalise.com/api2docs/curl/#transition-create-screenshots-post

$response = $client->screenshots->create(
    $projectId,
    [
        'screenshots' => [
            [
                'data' => 'data:image/jpeg;base64,D94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL.....',
                'key_ids' => [
                    12345, 12346
                ],
                'tags' => [
                    'onboarding',
                ],
            ],
            [
                'data' => \Lokalise\Utils::base64FileEncode('/tmp/onboarding.jpg'),
                'key_ids' => [
                    12347, 12348
                ],
                'tags' => [
                    'onboarding',
                ],
            ],
        ]
    ]
);

Retrieve a screenshot

https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-screenshot-get

$response = $client->screenshots->retrieve($projectId, $screenshotId);

Update a screenshot

https://app.lokalise.com/api2docs/curl/#transition-update-a-screenshot-put

$response = $client->screenshots->update(
    $projectId,
    $screenshotId,
    [
        'title' => 'Onboarding',
        'key_ids' => [
            12345, 12346, 12347
        ]
    ]
);

Delete a screenshot

https://app.lokalise.com/api2docs/curl/#transition-delete-a-screenshot-delete

$response = $client->screenshots->delete($projectId, $screenshotId);

⇚ Back