Request a particular page

Contents

    Get a particular page by the page key.

    All request to the API need the API Token, you can find the token in the settings of the plugin.

    Request

    • Endpoint: /api/pages/{key}
    • Method: GET

    Bellow the list of parameters allowed for this endpoint.

    key value Default value
    required token string API Token

    Response

    • HTTP Code: 200
    • Content-Type: application/json
    • Content
    {
        "status": "0",
        "message": "Page filtered by key: my-dog",
        "data": {
            "key": "my-dog",
            "title": "My dog",
            "content": "...",
            "contentRaw": "...",
            "description": "...",
            "type": "published",
            "slug": "my-dog",
            "date": "2019-02-02 00:09:38",
            "dateUTC": "2019-02-02 22:09:38",
            "tags": "",
            "permalink": "https://www.example.com/my-dog",
            "coverImage": false,
            "coverImageFilename": false
        }
    }

    CURL command example

    You can request a particular page by the page key, the follow example show how to get the page with the key my-dog.

    $ curl  -X GET \
        -G "https://www.example.com/api/pages/my-dog" \
        -d "token=80a09ba055b73f68e3c9e7c9ea12b432"

    Output:

    {
        "status": "0",
        "message": "Page filtered by key: my-dog",
        "data": {
            "key": "my-dog",
            "title": "My dog",
            "content": "...",
            "contentRaw": "...",
            "description": "...",
            "type": "published",
            "slug": "my-dog",
            "date": "2019-02-02 00:09:38",
            "dateUTC": "2019-02-02 22:09:38",
            "tags": "",
            "permalink": "https://www.example.com/my-dog",
            "coverImage": false,
            "coverImageFilename": false
        }
    }

    Javascript example

    You can use the Fetch API to get the page.

    <script>
        fetch("https://www.example.com/api/pages/my-dog?token=eaf5df0a626145cc6d37b76f3eccc826", {
            method: 'get'
        }).then(function(response) {
            return response.json();
        }).then(function(json) {
            console.log(json.data);
        });
    </script>