Developers

Mostly about Wild Apricot API. Feel free to share examples of your code!

  1. How to Encode Quotes in PHP for API

    I'm using PHP to create a new event via the API just fine. However if the Name of the event has single or double quotes or an ampersand sign, these get converted to utf8 unicode in the published WA event. I can't figure out what PHP encoding WA needs in the POST/PUT for the Name to get a properly decoded result in the WA admin. I've tried htmlentities(), htmlspecialchars(), and json_encode() to no avail.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  2. Deactivate

    I would like to be able to deactivate a member through the API. Deactivating a pending membership is possible through /rpc/{accountId}/RejectPendingMembership, but that doesn't seem to be intended for existing memberships.

    I tried sending a PUT to /rpc/Accounts/{accountId}/Contacts/{member_id} with 'MembershipEnabled: false', as well as setting FieldValues like "Member", "SuspendedMember", and "Membership enabled", but this returned a 400 error.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  3. Additional, Administrator-defined, Optionally-searchable Content Types

    Think it would be quite useful to have the ability to (optionally) define additional "Content Types", i.e., types other than the default set already provided (Page contents, Blogs, Forums, Events, & Public Member profiles).

    This capability would add an important, new dimension to the site wide Search Gadget, and would provide a user-configurable means to manage the scope of a user's search capability, by role!

    Such that:

    1. Any number of additional (optionally-defined) content types can be established by a site administrator

    2. These optionally-defined content types can be administrator-selected for inclusion/exclusion: (a) By role and (b) In the site search Gadget’s…

    7 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    2 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  4. GET, PUT, and POST for blog content

    I would like to be able to retrieve, update, and create blog posts via the API.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  5. How to trigger password reset email?

    I have implemented single sign on, but I want my login form to be able to trigger the password reset email (eg a "Forgotten Password?" link on the login form.

    I can see that there is a way to do this manually via the back end, but I need a way to trigger this via the API.

    Thanks
    John

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  6. Sending email via API

    I'm trying to use the send email API call - https://app.swaggerhub.com/apis-docs/WildApricot/wild-apricot_public_api/2.1.0#/Emailing.Operations/SendEmail but not having any luck.

    I've tried from the API browser and via a Google Apps script. In both, I just get a 400 error.

    I'm POSTing to https://api.wildapricot.org/v2.1/rpc/<ACCOUNT>/email/sendemail, with this as my body:
    {
    "Subject": "test email",
    "Body": "test email",
    "Recipients": [
    {
    "Id": 0,
    "Type": "IndividualRecipient",
    "Name": "test",
    "Email": "<HIDDEN>"
    }
    ],
    "EventId": <EVENTID>
    }

    (account, email and event id have been hidden). Each time, I get a 400 error: Parameter is required: EmailDraftParam.
    The swagger documentation doesn't mention a "EmailDraftParam". What am I doing wrong?

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    6 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  7. Add or update site content via API

    We want to be able to update selected pages and content blocks via the API. For example, our finance committee creates a monthly report that we'd like to publish as an HTML page. Allowing us to PUT and POST content would be very helpful.

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  8. How to drive the saggerhub api

    Hi. It appears that I should be able to use swaggerhub to pull data from my WA database with the API, but I can't figure out how to do this because the code in the code window of swagger is 'read only'. I can see that I have to change it so that it points to my WA site, and although I have an option to enter API key to authenticate, there seems no way to change the site. Help appreciated

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    7 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    I have to admit, authorization with login/password through swaggerhub stopped working. Authorization with API key (2-nd in a list) still works.

    I can recommend to use one of these options:
    1 POSTMAN – is a great tool to work with API. It is possible to import swagger description.

    2 Use our test tool at API browser. It is a web application located at https://api.wildapricot.org/ui/home/requestoauthtoken

  9. v2.1 getEventDetails returns 404 for existing events

    I have a list of event IDs that I need to verify still exist in WildApricot. For some of them, the call to /accounts/{accountId}/events/{eventId} returns a 404, even though I can search and find them in the admin UI (Events > Event List). I am not passing any filters to the API call.

    Any ideas why the API returns a 404?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  10. Integration to Reservation System

    Researching member management systems,Have/Can you integrate with Reservation System? We use RezExpertCentral Application. Member have to be active in order to make a reservation. Can your Admin API be used for that validation?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  11. Stripe Connect

    Hi there,
    We understand that Wild Apricot by default allows adding only 1 Stripe/Paypal account in payment settings.
    However we are trying to customize. We want to use Stripe Connect i.e. our Stripe account will have 5 bank accounts added inside it.
    When a user selects 1 of the 5 "Donation Types" from dropdown in donation form, we want to direct the funds to that donation types bank account inside our Stripe account.

    We have a custom php code to achieve this. However how can we use that php code or any other customization you recommend to achieve this functionality…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  12. Orders-products vs Payments?

    Hi Everyone,

    I would like to integrate shop orders and payments with an external platform, this means whenever a user buys a digital product through the store, the content is unlocked in the external platform.

    I'm digging around the API and found a complete API for payments and invoices but, unfortunately, payments and invoices don't have any relationship with orders and products.

    Are this unimplemented methods of the API?

    Thanks in advance for any response

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  13. Single sign on for Moodle

    Has anyone successfully setup single sign in authentication between WA and a Moodle installation? Looking for some guidance/assistance. Thanks in advance -

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    2 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  14. How can I get new member signup information?

    I need to get new member details into Drip.co. How do I go about doing that?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    4 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  15. Filtering Account Administrators

    How can I return a list of just account administrators?

    Using the API Browser, I tried both

    $filter=IsAccountAdministrator eq true

    and

    $filter="Administrator role.Id" eq 256

    both return this cryptic error:

    ErrorDetails: "One or more errors occurred."

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    2 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    Team Mobile responded

    Filtering of account admihnistrators is not supported yet. If you are not sure that filtering for some field is supported, then you can look at contact field description. ‘Administrator role’ field has flag “SupportSearch”: false. That’s why filtering fails.

    We will implement such filtering in one of future updates.

  16. API Event Registrations - Support filters beside list of ID's ?

    Does anyone know if the event registration call supports filters other than the list of ID's mention on the help page.

    Events can be filtered much like contacts but it does not specify for event registrations.

    I want to limit the list of registrations returned for a contact to only those today or later.

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    Team Mobile responded

    It is not possible in current version of API.

  17. API v2 Events - AccessLevel and Sorting

    Hi,

    I'm using the API v2 to extract Events for a custom event list in another site. So far, the API is working.

    I can get a list of event objects, but they seem to be in the order in which they were entered, not in the order of their dates! (date order should be the default sort, IMHO) Is there a way I can specify the sort order in the request URL?

    Also, the API returns ALL events regardless of access level: is there a way to restrict the returned set to be just public events?

    Thanks.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    3 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  18. Provide a working example using XML and Access 2016

    I am converting an existing (working) application based on the excel example provided by Wild Apricot to work with Access instead of Excel. All I need from the API is to download a list of members. I've found that the Excel code does not work with Access. I've found many workarounds on various VBA boards, but I'm stymied at the final step of actually downloading the XML for the membership roster.

    These three lines of code from the LoadContacts sub are the problem. The dim statement does not compile in Access. The error is that the 'user defined type is…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  19. Single Sign On Very simple Ruby on Rails snippet

    Hello,
    I have been able to implement bare bones Wild Apricot single sign on steps in a blank Ruby on Rails project, thanks to Wild Apricot support! Please find attached a redacted and commented version of the code here for anyone who is trying to do similar with their own custom web app. This snippet prints out the ID of the user who is signed in.
    Cheers!

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  20. Event registration types created via API cannot be edited in the web interface

    It is no longer possible to edit an event registration type in the web UI if it was created via an API call. Attempting to load these registration types causes Uncaught Error: Invalid cancellationBehavior to be thrown in the console and the page spins forever without loading.

    Unfortunately due to the asinine piecemeal implementation of the API it is only possible to set this field through the web interface. See the issue? Yet another reason why you should use your own dang API; you could catch these issues before they break your customers' workflow and piss them off.

    Console log…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  API  ·  Flag idea as inappropriate…  ·  Admin →

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
    Work in progress  ·  Team Mobile responded

    An ability to setup cancellation options will be added to the API in the next release – approximately at the end of the month. It’ll fix this issue also.

    Currently, we fixed all broken registration types (the cancellation option was set to “not allow”) but unfortunately new ones will be created with the same problem for now.

  • Don't see your idea?

Developers

Categories

Feedback and Knowledge Base