Blogs

Blogs API

Documentación de la API de Blog public

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /blogs/posts/url-slug-exists — Check url slug
• PUT /blogs/posts/{postId} — Actualizar Blog Post
• POST /blogs/posts — Crear Blog Post
• GET /blogs/authors — Obtener todos los authors
• GET /blogs/categories — Obtener todos los categories
• GET /blogs/posts/all — Obtener Blog posts by Blog Id
• GET /blogs/site/all — Obtener Blogs by Location Id

GET /blogs/posts/url-slug-exists

Check url slug The "Check url slug" API allows check the blog slug validation which is needed before publishing any blog post. Please use blogs/check-slug.readonly. you can find the POST Id from the post edit url.

Scopes requeridos: blogs/check-slug.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - urlSlug (query, string) (requerido) — - locationId (query, string) (requerido) — - postId (query, string) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /blogs/posts/{postId}

Actualizar Blog Post The "Update Blog Post" API allows you update blog post for any given blog site. Please use blogs/post-update.write

Scopes requeridos: blogs/post-update.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - title (requerido) — string - locationId (requerido) — string - blogId (requerido) — string — You can find the blog id from blog site dashboard link - imageUrl (requerido) — string - description (requerido) — string - rawHTML (requerido) — string - status (requerido) — string - imageAltText (requerido) — string - categories (requerido) — array — This needs to be array of category ids, which you can get from the category get api call. - tags — array - author (requerido) — string — This needs to be author id, which you can get from the author get api call. - urlSlug (requerido) — string - wordCount (requerido) — number - canonicalLink — string - publishedAt (requerido) — string — Provide ISO timestamp

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /blogs/posts

Crear Blog Post The "Create Blog Post" API allows you create blog post for any given blog site. Please use blogs/post.write

Scopes requeridos: blogs/post.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - title (requerido) — string - locationId (requerido) — string - blogId (requerido) — string — You can find the blog id from blog site dashboard link - imageUrl (requerido) — string - description (requerido) — string - rawHTML (requerido) — string - status (requerido) — string - imageAltText (requerido) — string - categories (requerido) — array — This needs to be array of category ids, which you can get from the category get api call. - tags — array - author (requerido) — string — This needs to be author id, which you can get from the author get api call. - urlSlug (requerido) — string - canonicalLink — string - publishedAt (requerido) — string — Provide ISO timestamp

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /blogs/authors

Obtener todos los authors The "Get all authors" Api return the blog authors for a given location Id. Please use "blogs/author.readonly"

Scopes requeridos: blogs/author.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de sede - limit (query, number) (requerido) — Number of authors to show in the listing - offset (query, number) (requerido) — Number of authors to skip in listing

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /blogs/categories

Obtener todos los categories The "Get all categories" Api return the blog categoies for a given location Id. Please use "blogs/category.readonly"

Scopes requeridos: blogs/category.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — - limit (query, number) (requerido) — Number of categories to show in the listing - offset (query, number) (requerido) — Number of categories to skip in listing

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /blogs/posts/all

Obtener Blog posts by Blog Id The "Get Blog posts by Blog Id" API allows you get blog posts for any given blog site using blog Id.Please use blogs/posts.readonly

Scopes requeridos: blogs/posts.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — - blogId (query, string) (requerido) — - limit (query, number) (requerido) — - offset (query, number) (requerido) — - searchTerm (query, string) — search for any post by name - status (query, string) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /blogs/site/all

Obtener Blogs by Location Id The "Get Blogs by Location Id" API allows you get blogs using Location Id.Please use blogs/list.readonly

Scopes requeridos: blogs/list.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — - skip (query, number) (requerido) — - limit (query, number) (requerido) — - searchTerm (query, string) — search for any post by name

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable