Jarside - API V1

Websites

With Jarside, you can add your Wordpress Website to our system in order to publish automatically all generated articles from Jarside. This only works with Wordpress.

If your site is not a Wordpress, you can easily get all of the generated articles through our api in order to send them to your site via your code.

You need to install the Jarside plugin on your Wordpress and create a specific user for Jarside with the role "Jarside Editor".

The website model

The website model contains all the information about the website. In addition, you can have some statistics about articles generated for this website.

Properties

Name
data
Type
object
Description

  • Name
    uuid
    Type
    string
    Description

    Unique identifier for the website.

  • Name
    url
    Type
    string
    Description

    The website url.

  • Name
    total_credits_used
    Type
    int
    Description

    Total credits used to generate articles for this website.

  • Name
    articles_count
    Type
    int
    Description

    Total articles generated with Jarside for this website.

  • Name
    categories_count
    Type
    int
    Description

    Total categories for this website. Categories are automatically retrieved from your Wordpress by Jarside.

  • Name
    created_at
    Type
    datetime
    Description

    Timestamp of when the article was created.

Name
status
Type
object
Description

  • Name
    login_is_unauthorized
    Type
    bool
    Description

    Indicates if we can no longer connect you to your website via the information you have provided.

  • Name
    is_unreachable
    Type
    bool
    Description

    Indicates if your website is no longer accessible.

GET/v1/websites/list

List all websites

This endpoint allows you to retrieve a paginated list of all your websites. By default, a maximum of 20 websites are shown per page.

Optional attributes

  • Name
    page
    Type
    integer
    Description

    Allows you to choose the page.

Request

GET
/v1/websites/list
curl -G https://api.jarside.ai/v1/websites/list \
  -H "Authorization: Bearer {token}" \
  -d page=1

Response

{
  "data": [
      {
          "data": {
              "uuid": "fd127af8-d847-4823-81f4-b6e60433b55e",
              "url": "https://affilisting.com/blog",
              "total_credits_used": 24,
              "articles_count": 11,
              "categories_count": 11,
              "created_at": "2023-02-16 18:14:15"
          },
          "status": {
              "login_is_unauthorized": 0,
              "is_unreachable": 0
          }
      }
  ],
  "links": {
      "first": "https://api.jarside.ai/v1/websites/list?page=1",
      "last": null,
      "prev": null,
      "next": null
  },
  "meta": {
      "current_page": 1,
      "from": 1,
      "path": "https://api.jarside.ai/v1/websites/list",
      "per_page": 20,
      "to": 1
  }
}
POST/v1/websites/create

Create a website

This endpoint allows you to add a new website to Jarside. This will allow you to assign this website to future articles that you will generate.

Required attributes

  • Name
    url
    Type
    string
    Description

    The url of your Wordpress.

  • Name
    login
    Type
    string
    Description

    The login of the account.

    Note: You need to install the Jarside plugin on your Wordpress and create a specific user for Jarside with the role "Jarside Editor".

  • Name
    password
    Type
    string
    Description

    The password of the account.

    Note: This information is strongly encrypted in our database.

Request

POST
/v1/websites/create
  curl --location --request POST 'https://api.jarside.ai/v1/websites/create' \
    --header 'Authorization: Bearer {token}' \
    --form 'url="https://affilisting.com/blog"' \
    --form 'login="jarside"' \
    --form 'password="OurAwesomeAndStrongPassword"'

Response

{
    "data": {
        "uuid": "fd127af8-d847-4823-81f4-b6e60433b55e",
        "url": "https://affilisting.com/blog",
        "total_credits_used": 0,
        "articles_count": 0,
        "categories_count": 0,
        "created_at": "2023-02-16 18:14:15"
    },
    "status": {
        "login_is_unauthorized": 0,
        "is_unreachable": 0
    }
}
GET/v1/websites/:uuid/show

Retrieve a website

This endpoint allows you to retrieve a website by providing the website uuid. Refer to the list at the top of this page to see which properties are included with website objects.

Request

GET
/v1/websites/fd127af8-d847-4823-81f4-b6e60433b55e/show
curl https://api.jarside.ai/v1/websites/fd127af8-d847-4823-81f4-b6e60433b55e/show \
  -H "Authorization: Bearer {token}"

Response

{
    "data": {
        "uuid": "fd127af8-d847-4823-81f4-b6e60433b55e",
        "url": "https://affilisting.com/blog",
        "total_credits_used": 24,
        "articles_count": 11,
        "categories_count": 11,
        "created_at": "2023-02-16 18:14:15"
    },
    "status": {
        "login_is_unauthorized": 0,
        "is_unreachable": 0
    }
}
DELETE/v1/websites/:uuid/delete

Delete a website

This endpoint allows you to delete a website.

This only delete the website but not all articles generated for this website. You cannot delete a generated article.

Request

DELETE
/v1/websites/fd127af8-d847-4823-81f4-b6e60.../delete
curl -X PUT https://api.jarside.ai/v1/websites/fd127af8-d847-4823-81f4-b6e60433b55e/delete \
  -H "Authorization: Bearer {token}" \

Response

{
    "message": "https://affilisting.com/blog has been successfully deleted!"
}