README

Official PHP prowritingaid.com API.

API version: v2

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/prowriting/prowritingaid.php.git"
    }
  ],
  "require": {
    "prowriting/prowriting.php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AsyncContextualThesaurusApi();
$request = new \Swagger\Client\Model\ContextualThesaurusRequest(); // \Swagger\Client\Model\ContextualThesaurusRequest | 

try {
    $result = $api_instance->asyncContextualThesaurusPost($request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AsyncContextualThesaurusApi->asyncContextualThesaurusPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.prowritingaid.com

Class	Method	HTTP request	Description
ContextualThesaurusApi	get	GET /api/async/contextualthesaurus/result/{taskId}	Tries to get the result of a request using the task id of the request
ContextualThesaurusApi	post	POST /api/async/contextualthesaurus	Analyses text and returns contextual thesaurus entries
HtmlApi	get	GET /api/async/html/result/{taskId}	Tries to get the result of a request using the task id of the request
HtmlApi	post	POST /api/async/html	Analyses HTML and adds suggestion tags to it
SummaryApi	get	GET /api/async/summary/result/{taskId}	Tries to get the result of a request using the task id of the request
SummaryApi	post	POST /api/async/summary	Gets the summary analysis of a document
TextApi	get	GET /api/async/text/result/{taskId}	Tries to get the result of a request using the task id of the request
TextApi	post	POST /api/async/text	Analyses html and adds suggestions tags to it
ThesaurusApi	post	POST /api/thesaurus	Returns the thesaurus entries for a specific word
WordCloudApi	get	GET /api/async/wordcloud/result/{taskId}	Tries to get the result of a request using the task id of the request
WordCloudApi	post	POST /api/async/wordcloud	Analyses text and returns a word cloud (as an image)

Documentation For Models

Documentation For Authorization

licenseCode

Type: API key
API key parameter name: licenseCode
Location: HTTP header

git_user_id / git_repo_id

Maintainers

Details