public ApiPlugin(ApiObjectContext objectContext, IWebConfigMangerHelper webConfigMangerHelper, ISettingService settingService, IWorkContext workContext,
ILocalizationService localizationService, IWebHelper webHelper)
{
_objectContext = objectContext;
_webConfigMangerHelper = webConfigMangerHelper;
_settingService = settingService;
_workContext = workContext;
_localizationService = localizationService;
_webHelper = webHelper;
}
private void ConfigureWebhooks(HttpConfiguration config)
{
// Check if the connection string in the config and actual connection string are different. If so update the one in the config.
IWebConfigMangerHelper webConfigManagerHelper = EngineContext.Current.ContainerManager.Resolve <IWebConfigMangerHelper>();
webConfigManagerHelper.AddConnectionString();
config.InitializeCustomWebHooks();
config.InitializeCustomWebHooksSqlStorage(false);
// This is required only in development.
// It it is required only when you want to send a web hook to an https address with an invalid SSL certificate. (self-signed)
// The code marks all certificates as valid.
// We may want to extract this as a setting in the future.
// NOTE: If this code is commented the certificates will be validated.
ServicePointManager.ServerCertificateValidationCallback += (sender, cert, chain, sslPolicyErrors) => true;
}
public void RegisterRoutes(RouteCollection routes)
{
routes.MapRoute("Plugin.Api.Settings",
"Plugins/ApiAdmin/Settings",
new { controller = "ApiAdmin", action = "Settings", },
new[] { "Nop.Plugin.Api.Controllers.Admin" }
);
routes.MapRoute("Plugin.Api.ManageClients.List",
"Plugins/ManageClientsAdmin/List",
new { controller = "ManageClientsAdmin", action = "List" },
new[] { "Nop.Plugin.Api.Controllers.Admin" }
);
routes.MapRoute("Plugin.Api.ManageClients.Create",
"Plugins/ManageClientsAdmin/Create",
new { controller = "ManageClientsAdmin", action = "Create" },
new[] { "Nop.Plugin.Api.Controllers.Admin" }
);
routes.MapRoute("Plugin.Api.ManageClients.Edit",
"Plugins/ManageClientsAdmin/Edit/{id}",
new { controller = "ManageClientsAdmin", action = "Edit", id = @"\d+" },
new[] { "Nop.Plugin.Api.Controllers.Admin" }
);
routes.MapRoute("Plugin.Api.ManageClients.Delete",
"Plugins/ManageClientsAdmin/Delete/{id}",
new { controller = "ManageClientsAdmin", action = "Delete", id = @"\d+" },
new[] { "Nop.Plugin.Api.Controllers.Admin" }
);
IWebConfigMangerHelper webConfigManagerHelper = EngineContext.Current.ContainerManager.Resolve <IWebConfigMangerHelper>();
// make sure the connection string is added in the Web.config
webConfigManagerHelper.AddConnectionString();
// make sure the OwinAutomaticAppStartup is enabled in the Web.config
webConfigManagerHelper.AddConfiguration();
}
public override void Install()
{
// Add the nopCommerce connection string to the web.config file. This is required by the WebHooks.
IWebConfigMangerHelper webConfigManagerHelper = EngineContext.Current.ContainerManager.Resolve <IWebConfigMangerHelper>();
webConfigManagerHelper.AddConnectionString();
_objectContext.Install();
//locales
this.AddOrUpdatePluginLocaleResource("Plugins.Api", "Api plugin");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Menu.ManageClients", "Manage Api Clients");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Configure", "Configure Web Api");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.GeneralSettings", "General Settings");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.EnableApi", "Enable Api");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.EnableApi.Hint", "By checking this settings you can Enable/Disable the Web Api");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.AllowRequestsFromSwagger", "Allow Requests From Swagger");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.AllowRequestsFromSwagger.Hint", "Swagger is the documentation generation tool used for the API (/Swagger). It has a client that enables it to make GET requests to the API endpoints. By enabling this option you will allow all requests from the swagger client. Do Not Enable on live site, it is only for demo sites or local testing!!!");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Menu.Title", "API");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Menu.Settings.Title", "Settings");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Menu.Clients.Title", "Clients");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Menu.Docs.Title", "Docs");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Page.Settings.Title", "Api Settings");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Page.Clients.Title", "Api Clients");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Page.Clients.Create.Title", "Add a new Api client");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Page.Clients.Edit.Title", "Edit Api client");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.Name", "Name");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.Name.Hint", "Name Hint");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.ClientId", "Client Id");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.ClientId.Hint", "The id of the client");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.ClientSecret", "Client Secret");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.ClientSecret.Hint", "The client secret is used during the authentication for obtaining the Access Token");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.CallbackUrl", "Callback Url");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.CallbackUrl.Hint", "The url where the Authorization code will be send");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.IsActive", "Is Active");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.IsActive.Hint", "You can use it to enable/disable the access to your store for the client");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.AddNew", "Add New Client");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.Edit", "Edit");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.Created", "Created");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.Deleted", "Deleted");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Entities.Client.FieldValidationMessages.Name", "Name is required");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Entities.Client.FieldValidationMessages.ClientId", "Client Id is required");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Entities.Client.FieldValidationMessages.ClientSecret", "Client Secret is required");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Entities.Client.FieldValidationMessages.CallbackUrl", "Callback Url is required");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Settings.GeneralSettingsTitle", "General Settings");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Edit", "Edit");
this.AddOrUpdatePluginLocaleResource("Plugins.Api.Admin.Client.BackToList", "Back To List");
this.AddOrUpdatePluginLocaleResource("Api.Categories.Fields.Id.Invalid", "Id is invalid");
this.AddOrUpdatePluginLocaleResource("Api.InvalidPropertyType", "Invalid Property Type");
this.AddOrUpdatePluginLocaleResource("Api.InvalidType", "Invalid {0} type");
this.AddOrUpdatePluginLocaleResource("Api.InvalidRequest", "Invalid request");
this.AddOrUpdatePluginLocaleResource("Api.InvalidRootProperty", "Invalid root property");
this.AddOrUpdatePluginLocaleResource("Api.NoJsonProvided", "No Json provided");
this.AddOrUpdatePluginLocaleResource("Api.InvalidJsonFormat", "Json format is invalid");
this.AddOrUpdatePluginLocaleResource("Api.Category.InvalidImageAttachmentFormat", "Invalid image attachment base64 format");
this.AddOrUpdatePluginLocaleResource("Api.Category.InvalidImageSrc", "Invalid image source");
this.AddOrUpdatePluginLocaleResource("Api.Category.InvalidImageSrcType", "You have provided an invalid image source/attachment ");
this.AddOrUpdatePluginLocaleResource("Api.WebHooks.CouldNotRegisterWebhook", "Could not register WebHook due to error: {0}");
this.AddOrUpdatePluginLocaleResource("Api.WebHooks.CouldNotRegisterDuplicateWebhook", "Could not register WebHook because a webhook with the same URI and Filters is already registered.");
this.AddOrUpdatePluginLocaleResource("Api.WebHooks.CouldNotUpdateWebhook", "Could not update WebHook due to error: {0}");
this.AddOrUpdatePluginLocaleResource("Api.WebHooks.CouldNotDeleteWebhook", "Could not delete WebHook due to error: {0}");
this.AddOrUpdatePluginLocaleResource("Api.WebHooks.CouldNotDeleteWebhooks", "Could not delete WebHooks due to error: {0}");
this.AddOrUpdatePluginLocaleResource("Api.WebHooks.InvalidFilters", "The following filters are not valid: '{0}'. A list of valid filters can be obtained from the path '{1}'.");
ApiSettings settings = new ApiSettings
{
EnableApi = true,
AllowRequestsFromSwagger = false
};
_settingService.SaveSetting(settings);
base.Install();
// Changes to Web.Config trigger application restart.
// This doesn't appear to affect the Install function, but just to be safe we will made web.config changes after the plugin was installed.
_webConfigMangerHelper.AddConfiguration();
}
public ApiPlugin(ApiObjectContext objectContext, IWebConfigMangerHelper webConfigMangerHelper)
{
_objectContext = objectContext;
_webConfigMangerHelper = webConfigMangerHelper;
}
