keys.md

Keys API

List project keys

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

$response = $client->keys->list(
    $projectId,
    [
        'limit' => 20,
        'page' => 1,
        'filter_placeholder_mismatch' => 1,
        'filter_platforms' => [
            'web',
            'other',
        ],
    ]
);

$response = $client->keys->fetchAll(
    $projectId,
    [
        'filter_placeholder_mismatch' => 1,
        'filter_platforms' => [
            'web',
            'other',
        ],
    ]
);

Create keys

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

$response = $client->keys->create(
    $projectId,
    [
        'keys' => [
            [
                'key_name' => 'index.title',
                'description' => 'Title of main page',
                'platforms' => [
                    'web',
                ],
                'filenames' => [
                    'web' => 'main.json',
                ],
                'tags' => [
                    'index',
                ],
                'translations' => [
                    [
                        'language_iso' => 'en',
                        'translation' => 'Welcome to main page!',
                    ],
                ],
                'char_limit' => 80,
            ],
            [
                'key_name' => 'index.meta.title',
                'description' => 'META Title of main page',
                'platforms' => [
                    'web',
                ],
                'filenames' => [
                    'web' => 'main.json',
                ],
                'tags' => [
                    'index', 'meta',
                ],
                'translations' => [
                    [
                        'language_iso' => 'en',
                        'translation' => 'Main page',
                    ],
                ],
                'char_limit' => 20,
            ],
        ],
    ]
);

Retrieve a key

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

$response = $client->keys->retrieve($projectId, $keyId);

Update a key

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

$response = $client->keys->update(
    $projectId,
    $keyId,
    [
        'tags' => [
            'index', 'meta', 'updated',
        ],
    ]
);

Update multiple keys (bulk update)

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

$response = $client->keys->bulkUpdate(
    $projectId,
    [
        'keys' => [
            [
                'key_id' => 420,
                'tags' => [
                    'index', 'meta', 'updated',
                ],
                'translations' => [
                    [
                        'language_iso' => 'en',
                        'translation' => 'Frontpage',
                    ],
                ],
            ],
            [
                'key_id' => 421,
                'tags' => [
                    'updated',
                ],
            ],
        ],
    ]
);

Delete a key

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

$response = $client->keys->delete($projectId, $keyId);

Delete multiple keys

https://app.lokalise.com/api2docs/curl/#transition-delete-multiple-keys-delete

$response = $client->keys->bulkDelete(
    $projectId,
    [
        'keys' => [
            12345, 12346,
        ],
    ]
);

⇚ Back