1. When I am calling Edit discussion API
   {domain}/api/discussions/1/comments?authparameters

I am calling API with administrator credentials so What might be the reason for following error?

2. When I am calling Add comment
   {domain}/api/discussions/33/comments?authparameters
   

3. When I am calling my discussion api
   {domain}/api/discussions/mine?authparameters
   

Is there anything wrong with discussions controller?

4. Is there any API for Login which can let the user sign in app with their credentials?
   I am using signature based authentication.My authentication is valid as It work for all other APIs.

I appreciate your suggestions. I got active in Vanilla forum and your addon for developing my mobile app based on vanilla forum.

I am developing mobile application using your addon.

It is currently impossible to create and endpoint that makes use of two named numeric values. E.g. PUT /discussions/:id/tags/:tid will map to PUT /discussions/:id/tags/:id.

I am looking to create (via PUT) and remove (via GET) relationships between objects like this. Is this the wrong way of thinking within a RESTful API?

Yesterday I tried installing your plugin for vanilla forums so I can use a number of endpoints it has to offer. I got to the point of generating an endpoint url and secret but the url generated gives me a page not found error. http://localhost:8888/vanilla-forum/index.php?p=/api

I get an error about how it cannot find the API_Engine class (called from the class.hooks.php file). Problem is that the class is declared as APIEngine.

How get second page of discussions?
When I use {{domain}}/api/discussions/:id I only get first page.

Hi Kasper,

I'm testing out vanilla forums/the api to see if it will fit my use case. In the course of that, I tried updating a user through the api, and I can't get it to work; I receive a 400 response that says "You must select at least one role." I'm definitely including an array of role IDs.

I'm running vanilla locally (using MAMP). I can successfully update a user through the api using Postman (I also tried RESTClient just for kicks, and it worked as well), but I haven't been successful using cURL in either a PHP script or from the command-line (Mac OS 10.7, curl version 7.21.4).

Here's what I did from the command-line:

curl -v -X PUT -H "Content-Type: application/json"  '{"Name":"test","Email":"[email protected]","Password":"password","RoleID":[8]}' "http://localhost/api/users/3?username=[username]&timestamp=[timestamp]&token=[token]"

And this is the response I get:

{
  "AllowEditing": true,
  "User": {
    "UserID": "3",
    "Name": "test",
    "Photo": null,
    "Title": null,
    "Location": null,
    "About": null,
    "Email": "[email protected]",
    "ShowEmail": "0",
    "Gender": "u",
    "CountVisits": "0",
    "CountInvitations": "0",
    "CountNotifications": null,
    "InviteUserID": null,
    "DiscoveryText": null,
    "Preferences": null,
    "DateSetInvitations": null,
    "DateOfBirth": null,
    "DateFirstVisit": "2015-03-11 00:12:27",
    "DateLastActive": "2015-03-11 00:12:27",
    "LastIPAddress": "127.0.0.1",
    "AllIPAddresses": null,
    "DateInserted": "2015-03-11 00:12:27",
    "InsertIPAddress": "127.0.0.1",
    "DateUpdated": "2015-03-13 06:00:48",
    "UpdateIPAddress": "127.0.0.1",
    "HourOffset": "0",
    "Score": null,
    "Admin": "0",
    "Confirmed": "1",
    "Verified": "0",
    "Banned": "0",
    "Deleted": "0",
    "Points": "0",
    "CountUnreadConversations": null,
    "CountDiscussions": null,
    "CountUnreadDiscussions": null,
    "CountComments": null,
    "CountDrafts": null,
    "CountBookmarks": null,
    "_CssClass": "",
    "ConfirmEmail": 1
  },
  "Roles": {
    "2": "Guest",
    "3": "Unconfirmed",
    "4": "Applicant",
    "8": "Member",
    "32": "Moderator",
    "16": "Administrator"
  },
  "UserRoles": [

  ],
  "Code": 400,
  "Exception": "You must select at least one role."
}

I get the same response when I use cURL in PHP. I haven't been able to find any differences between the Postman client and what I'm doing in cURL. I'm definitely supplying user roles; I have a suspicion that the error message is a red herring.

I've tried recreating every single insignificant header, triple-checking the json...I can' t understand why my cURL request isn't working. Have you experienced this? Can you successfully update a user via the api with cURL, either from the command-line or PHP?

Still can't get it work; api is loaded; but haven't process any requests;
As I can see there is a problem in class.hooks.php on line 50;
cuz after APIEngine::SetHeaders($Request); I have nothing

Changing
throw new Exception(t('API.Error.Class.Invalid'), 404);
to something like
throw new Exception(t('API.Error.Class.Invalid: ' . $class . ''), 404);

Would provide better debugging info.

When I post a new comment in a discussion via the RESTful API, the comment is visible in the discussion itself. But on the frontpage/mainpage of the forum I don't see the author of the last comment, I only see the second last comment author.

Can it be that when posting a new comment in a discussion there is some other logic which needs to be added in the RESTful API, so the frontpage/mainpage of the forum shows the last comment author?

hi,
the HTTP_CONTENT_TYPE is no longer supported as per the CGI/1.1 specification so I change to $type = static::getServerArguments('CONTENT_TYPE');

but the return value displays all the html pages, and no luck of posting the body

Hi Kasper,

I have downloaded and installed the develop branch and enabled your API (0.3.0), however on calling post methods it gets into an infinite loop of dispatch calls

[Wed Jan 28 22:44:00.282126 2015] [:error] [pid 20465] [client 127.0.0.1:38676] PHP 89. Gdn_Dispatcher->Dispatch() /srv/eci-mgt/vanilla/library/core/class.dispatcher.php:372
And what really makes me curious:

To resolve this it helps to create a category via the dashboard :(

Any clue what might cause this? Or which branch / version of vanilla are you proposing to use best with your api?

br
Thomas

PS: Its kinda reproducable....

http://54.200.224.132/vanilla2/index.php?p=/discussion/3/ works fine.

My env:
vanilla-2.1.11
pwd
htdocs/vanilla2/applications/api
cd api
git log
commit e027615
Author: Kasper Isager [email protected]
Date: Wed Aug 12 16:20:50 2015 +0200

Fix formatting error.

Could you please help?

So... I've repeated this process 4 or 5 times just to make sure. I download either Vanilla Forums 2.2.3.4 or Vanilla Forums 2.2.3.6, install it, download api 0.4.0, copy it, open the admin dashboard, enable api application and BAM! "Something has gone wrong." Forum unusable forever. Repeat.

EDIT: Managed to get a backtrace:

Call to unknown method 'Gdn_Request->requestUri'
The error occurred on or near: D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.request.php

128:          $PassedArg = (is_array($Args) && sizeof($Args)) ? $Args[0] : NULL;
129:          return $this->_EnvironmentElement(strtoupper($Matches[2]),$PassedArg);
130:       }
131:       else {
132:          trigger_error("Call to unknown method 'Gdn_Request->{$Method}'", E_USER_ERROR);
133:       }
134:    }
135: 
136:    /**

Backtrace:

D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.request.phpPHP::Gdn_ErrorHandler();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.request.php:132] PHP::trigger_error();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\applications\api\library\class.apiengine.php:304] Gdn_Request->__call();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\applications\api\library\class.apiengine.php:304] Gdn_Request->requestUri();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\applications\api\settings\class.hooks.php:57] APIEngine::getRequestUri();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.pluginmanager.php:724] APIHooks->Gdn_Dispatcher_beforeDispatch_handler();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.pluginmanager.php:657] Gdn_PluginManager->CallEventHandler();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.pluggable.php:144] Gdn_PluginManager->CallEventHandlers();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\library\core\class.dispatcher.php:189] Gdn_Pluggable->FireEvent();
[D:\xampp\htdocs\vanilla-Vanilla_2.2.3.4\index.php:46] Gdn_Dispatcher->Dispatch();

Variables in local scope:

[Method] 'requestUri'
[Args] array (
)    
[Matches] array (
 )

It would be nice if there was an endpoint where you can retrieve the latest comments (overall, placed anywhere on the forum).

I have installed the api application on a "self hosted" server.

I am trying to test it out with the following api

http://example.com/api/categories

but get the following error.
FILE: /var/www/forums/library/core/class.request.php
131: trigger_error("Call to unknown method 'Gdn_Request->{$Method}'", E_USER_ERROR);

What could the issue be ?

the same issue as #58
/api/discussions/3
/api/discussions/2
does not work, give 404 error

I'm planning on using this to integrate VF with my Drupal site. I've got the application in stalled and enabled (I think). A very simple "hello world" example of how to use the API would be a big help.

Thanks.

-Mike

Hello. Much thanks again Kasper for the time you took out to develop this application.
I keep getting bonked (blank browser window) whenever I upload the application files onto my server. I am using the Vanilla Master(2.2) downloaded from https://github.com/vanilla/vanilla. I also changed the folder name to 'api' on my server. Please help

Trying to enable 0.2.0 in Vanilla 2.2.16.6 (upgraded from 2.1) and when I hit the "Enable" button in /settings/applications/all, it fails to enable (ie, the "Enable" button still shows instead of "Disable").

No relevant error message in the PHP log.

I've tried to implement authentication by SecretKey, and now I have two questions:

1. It's kind a strangely that you need to pass user email or id even if you use a secret key as authentication method
2. https://github.com/kasperisager/vanilla-api/blob/master/library/class.apiengine.php#L123
   in method Signature when you calculate it, in request params you are using DeliveryMethod and DeliveryType; because of them i've receive auth error messages.

Hi, I noticed that the settings/about.php file contains shorthand array syntax which was only introduced in PHP 5.4.

As Vanilla 2.1 supports 5.2 and 2.2 supports 5.3, then shouldn't this plugin also support those versions of PHP?

Hi,
The client has Vanilla 2.1, They don't want to upgrade to 2.2 yet.
I tried enabling the API Application, but I get an error "Success"
I think it should be just disabling some output.

Hi,

when adding a user the forum/your API returns an empty array - in your endpoint wiki you state, that user,activities, roles arrays are returned. Without any info on the created user (id etc.) it is not possible to go on with some postProcessing in own controllers/applications.

Is this a bug in your API or a misbehaviour in the vanilla core ?

This looks like exactly what I'm after but I can't seem to get the application enabled. I get a big ugly message that says:

Parse error: syntax error, unexpected ':' in mysite/public_html/simple/applications/api/settings/class.hooks.php on line 35

it will be good if it can do pagination of discussions or comments. if we have lots of discussion, the load will be pretty heavy?

Hello,

I install new forum 2.2.13 and I enable the API. But whenever I try to access it via /index.php?p=/api it say Page Not Found.

Thanks

It looks like Vanilla 2.2 is not available in the master branch anymore. How can I get the API working? Thanks.

If your vanilla forum is installed in a sub directory ie: domain.com/forum/ the api target does not match the sub folder. The endpoint points to domain.com/api/ instead of pointing to domain.com/forum/api/. The problem lies in the call Gdn::request()->domain() which does not seem to account for sub folder detection.

To fix this every call to Gdn::request()->domain() within the api needs to be replaced with Gdn::request()->domain() ."/". Gdn::request()->WebRoot();

I've installed this application on a brand new Vanilla 2.2 install and when I attempt to enable it in the Vanilla dashboard I get a white screen. When I enable debug in Vanilla I get the following error in the browser:

Parse error: syntax error, unexpected '[' in D:\wamp\www\vanillaforums\applications\api\settings\bootstrap.php on line 6

Hi, I am so happy that you built this API, it is going to be really helpful. If we turn out to use it, I make sure my company donates some money to you. That left aside, for now I'm kinda lost. Therefore a couple questions:

1. I'm trying to find the API url, but localhost/api, 127.0.0.1/api, and 127.0.0.1/~kramer65/vanilla/api all give me a 404. Any ideas what it could be?
2. Can it be used like a public API, or do I always need to authenticate?
3. Most importantly; is there some example code anywhere? A simple php file which connects and gets some messages or something?

All tips are welcome!

Hi, i have a problem when i try to create a new category. (POST /categories)

When I do the CURL call to my localhost, i get this:

Fatal error: Allowed memory size of 268435456 bytes exhausted (tried to allocate 24 bytes) in D:\Guillermo\GIT\xxxxxxxxx\library\core\class.dispatcher.php on line 608

xxxxxx is the name of the proyect

any ideas? , i try increasing the memory limit, but no matter how much i set, all is used...

I dont have any problem with GET calls

I'm using the master version of Vanilla Forum. But when I try to change the settings for the API I'm getting the error "View not found.".

I checked but the view is there and the permissions are correct.

Hi Kasper,
I've installed Vanilla API, but can't get it to work. I'm using Vanilla 2.2.4 and API 0.0.9-dev on a Mac (10.8.5).
http://localhost/vanilla/index.php?p=/discussion/1 works fine, but http://localhost/vanilla/api/discussion/1 gives a 404.
In the apache error log it says:
File does not exist: /Library/WebServer/Documents/vanilla/api

Could it be because my /Library/WebServer/Documents/vanilla is a symlink to the real vanilla location?

Thanks,
Daniel

When creating a category, the field "UrlCode" returns error with some characters, like quotes and slashes, but accepts other invalid characters, like #

HI,
What should be the timestamp value while calling APIs?
I appreciate your support.
Thanks.

Just did a fresh install on latest Vanilla / master branch. The api endpoints give 404 errors, the admin side looks fine though. Api installed in applications/api.

Hi!

I am using Vanilla, version 2.2.12, and Vanilla API addon, version 0.4, and i use apache web server

The endpoint i get in API config is http://bkkbn.dojo-box.com/index.php?p=/api/

But i get not found everytime i try to acces, i try with the postman client collection that kasper provided, and still getting not found.

Someone have a lead what could be, or what i am doing wrong?

Thanks in advance

I am having issues while calling any of the APIs that require Auth.
For example, I call categories with method PUT to edit that category,I passed username,email,token(Vanilla settings page Seceret label),name,urlcode

{domain}/api/categories/3?name={name}&urlcode={urlcode}&username={username}&email={email}&token={token}

Category with id 3 didnt got update.

What might be wrong in calling API?

Thanks.

I am using Vanilla 2.2.x in localhost.

It is only calling the Comment method, but also needs CommentModel->Save2 to update meta

Thanks for Support earlier.

When I Call "Add User" API, Mail Has been sent to registered user. But The mail contains Username which I use for authentication.For example Authentication is using xyz user and The user I create is abc..Then If I call api to create user named abc with authentication of xyz...Mail received is : xyz has created your account abc.Your user login details are etcetc.

I'm implementing a Ruby gem that wraps the API provided by this project for integrating vanilla with our Ruby-on-Rails web site. Unfortunately, there are a lot of endpoints that do not give the expected behavior. All GET endpoints are fine, however most POST/PUT/DELETE endpoints are broken. This is very frustrating for us as we couldn't find any other API for vanilla integration. Here are what I get:

• Users:
  • PUT /users/id: Has no effect.
  • POST /users: There is no documentation whatsoever as to how to specify a role in the json body, so I don't know how to format the request for user creation.
  • DELETE /users/id: I get {"Code":405,"Exception":"API.Error.MethodNotAllowed"}
• Conversations:
  • POST /conversations/id/messages: Has no effect.
• Roles:
  • PUT /roles/id: Creates a new role with the supplied parameters, rather than updating the one IDed.
  • DELETE /roles/id: Has no effect.
  • POST /roles: There is no documentation for the possible values of the "Permission" field in the json body.
• Categories:
  • PUT /categories/id: Creates a new category with the supplied parameters, rather than updating the one IDed.
  • DELETE /categories/id: Has no effect.
• Discussions:
  • POST /discussions/id/comments: I get the following PHP error: PHP Fatal error: Call to a member function FirstRow() on string in /var/www/vanilla/applications/vanilla/controllers/class.postcontroller.php on line 745
  • PUT /discussions/id: Creates a new discussion with the supplied parameters, rather than updating the one IDed.

The most crucial thing that we need to be able to do through the API is to programatically create new users and post comments. I'm not experienced with PHP, but I'm willing to dive into the code base of either the API app or the vanilla app, so any help, insights, hints as to how to fix these issues would be greatly appreciated, let alone fixes!

This would enable easier use of trivial query string parameters such as Limit, Offset, etc. as the token wouldn't have to be re-generated each time these change.

Today I updated Vanilla to the most recent master release, installed the current master branch api and it throws a 404 on every request to {{vanilla}}/api.

Maybe something's changed in the Vanilla router?

Hi,

is it possible to set the photourl property when adding a user ? in the Profile Object in the response of "find a user" the PhotoUrl/Photo prop is returned - but where can it be set ?

Website become blank when i extract this plugin to /applications,
do you know how to fix that?

thankyou.

ps: i already rename file to "api" but it was not work

Hi Kasper,

EXCELLENT stuff you've done...
I would like to integrate vanilla to my website using your api and have user synced via calls to create and delete users acccordingly...

But it was troublesome to collect all sorts of infos from all around the web to get it running...

Is there any indepth documentation about your API avail? like how to specify the search string in the search call e.g.

Kudos and all the best
Thomas

It would be nice to be able to list a users discussions elsewhere in a application based on the userid. In my case I have need for this because I'm building a profile somewhere else in my application and want to disable the forum profile.

Hi Kasper,

http://vanillaforums.org/messages/6088#latest

While accessing the request urls, I get 404 error and when I navigate to settings page, It says View not found.

I tried editing htaccess from the discussions on community and even set Rewrite urls to TRUE but in not working any solution.

I am using vanilla 2.1 on localhost/forum