The first website proofreading API

Whether you're managing a single site or overseeing hundreds, the Spling API simplifies the process of identifying and addressing content issues. Here's how developers integrate the Spling API into their QA process.

If you prefer to use the website version, you can use the Spling website spell checking service.

1. Easy integration and setup

The Spling API is designed with simplicity in mind, allowing developers to quickly get started with minimal setup:

• Request your API key via email at api@spl.ing.
• Authenticate your requests with a straightforward API key header:

headers = {
    'Authorization': 'your_api_key',
    'Content-Type': 'application/json'
}

2. Automated website scanning

With Spling, analyzing your website's content is easy and automated:

• Quickly fetch pages from your website's sitemap with the /get_pages endpoint:

POST https://api.spl.ing/v1.0/get_pages
{
  "website": "https://example.com"
}

Poll the endpoint until your sitemap analysis is complete, ensuring all relevant pages are retrieved effortlessly.

3. Report creation

Once you've identified the pages you want to analyze, creating a detailed spell-check report is straightforward:

• Create targeted reports for selected pages using the /create_report endpoint:

POST https://api.spl.ing/v1.0/create_report
{
  "website": "https://example.com",
  "pages": [
    "https://example.com/home",
    "https://example.com/about"
  ],
  "num_unselected_pages": 50,
  "config": {"preferredLanguage": "en-GB"}
}

• Crawling the site and organizing the content will take a few minutes, when Spling is done you will receive a URL-friendly identifier (uuid) for easy access to the completed report:

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "website_pretty": "example.com"
}

Spling offers practical insights and actionable results

Spling doesn't just find mistakes—it provides clear and actionable insights:

• Each report offers a clear overview of typos and content issues, letting your team swiftly address and correct errors.
• Share comprehensive, easy-to-understand report links directly with stakeholders:

Example Spling report:

https://www.spl.ing/report-card?website=www.microsoft.com&uuid=5bb10718-e7bc-43f5-99bf-552d108c0509

Scalable approach to QA

Whether your website has ten pages or thousands, the Spling API scales effortlessly:

• Automate your content checks as part of regular site maintenance or within CI/CD pipelines.
• Manage detailed or extensive websites seamlessly, without sacrificing speed or reliability.

Integrate the Spling API today and keep your content consistently polished, error-free, and trustworthy.

What's next for the Spling API?

We are continually improving the Spling API to better serve developer needs. Future enhancements might include:

• Real-time webhook notifications for completed reports.
• Enhanced integration with popular CMS platforms.
• Advanced configuration options for multilingual websites.
• Endpoints for a CSV or Excel report deliverable.

Have an idea or need specific features? We'd love to hear your suggestions!

For questions, support, or feature requests, please reach out to us at api@spl.ing.

‍